@aws-sdk/client-s3 3.842.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 +19 -19
|
@@ -30,19 +30,17 @@ declare const PutBucketMetricsConfigurationCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
33
|
+
* <p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can
|
|
34
|
+
* have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics
|
|
35
|
+
* configuration, note that this is a full replacement of the existing metrics configuration. If you don't
|
|
36
|
+
* include the elements you want to keep, they are erased.</p>
|
|
37
37
|
* <p>To use this operation, you must have permissions to perform the
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* <p>The following operations are related to
|
|
45
|
-
* <code>PutBucketMetricsConfiguration</code>:</p>
|
|
38
|
+
* <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by default. The
|
|
39
|
+
* bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
40
|
+
* Resources</a>.</p>
|
|
41
|
+
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
42
|
+
* CloudWatch</a>.</p>
|
|
43
|
+
* <p>The following operations are related to <code>PutBucketMetricsConfiguration</code>:</p>
|
|
46
44
|
* <ul>
|
|
47
45
|
* <li>
|
|
48
46
|
* <p>
|
|
@@ -68,8 +66,8 @@ declare const PutBucketMetricsConfigurationCommand_base: {
|
|
|
68
66
|
* </p>
|
|
69
67
|
* <ul>
|
|
70
68
|
* <li>
|
|
71
|
-
* <p>Description: You are attempting to create a new configuration but have
|
|
72
|
-
*
|
|
69
|
+
* <p>Description: You are attempting to create a new configuration but have already reached the
|
|
70
|
+
* 1,000-configuration limit.</p>
|
|
73
71
|
* </li>
|
|
74
72
|
* <li>
|
|
75
73
|
* <p>HTTP Status Code: HTTP 400 Bad Request</p>
|
|
@@ -31,50 +31,44 @@ declare const PutBucketNotificationConfigurationCommand_base: {
|
|
|
31
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
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* the destination where you want Amazon S3 to publish an event notification when it detects an
|
|
39
|
-
* event of the specified type.</p>
|
|
34
|
+
* notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event Notifications</a>.</p>
|
|
35
|
+
* <p>Using this API, you can replace an existing notification configuration. The configuration is an XML
|
|
36
|
+
* file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3
|
|
37
|
+
* to publish an event notification when it detects an event of the specified type.</p>
|
|
40
38
|
* <p>By default, your bucket has no event notifications configured. That is, the notification
|
|
41
|
-
*
|
|
39
|
+
* configuration will be an empty <code>NotificationConfiguration</code>.</p>
|
|
42
40
|
* <p>
|
|
43
41
|
* <code><NotificationConfiguration></code>
|
|
44
42
|
* </p>
|
|
45
43
|
* <p>
|
|
46
44
|
* <code></NotificationConfiguration></code>
|
|
47
45
|
* </p>
|
|
48
|
-
* <p>This action replaces the existing notification configuration with the configuration you
|
|
49
|
-
*
|
|
50
|
-
* <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
* <p>You can disable notifications by adding the empty NotificationConfiguration
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* configuration with the required <code>s3:PutBucketNotification</code> permission.</p>
|
|
46
|
+
* <p>This action replaces the existing notification configuration with the configuration you include in
|
|
47
|
+
* the request body.</p>
|
|
48
|
+
* <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service
|
|
49
|
+
* (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner
|
|
50
|
+
* has permission to publish to it by sending a test notification. In the case of Lambda destinations,
|
|
51
|
+
* Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the
|
|
52
|
+
* Amazon S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3
|
|
53
|
+
* Events</a>.</p>
|
|
54
|
+
* <p>You can disable notifications by adding the empty NotificationConfiguration element.</p>
|
|
55
|
+
* <p>For more information about the number of event notification configurations that you can create per
|
|
56
|
+
* bucket, see <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service
|
|
57
|
+
* quotas</a> in <i>Amazon Web Services General Reference</i>.</p>
|
|
58
|
+
* <p>By default, only the bucket owner can configure notifications on a bucket. However, bucket owners
|
|
59
|
+
* can use a bucket policy to grant permission to other users to set this configuration with the required
|
|
60
|
+
* <code>s3:PutBucketNotification</code> permission.</p>
|
|
64
61
|
* <note>
|
|
65
|
-
* <p>The PUT notification is an atomic operation. For example, suppose your notification
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* configuration to your bucket.</p>
|
|
62
|
+
* <p>The PUT notification is an atomic operation. For example, suppose your notification configuration
|
|
63
|
+
* includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with
|
|
64
|
+
* this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT
|
|
65
|
+
* action will fail, and Amazon S3 will not add the configuration to your bucket.</p>
|
|
70
66
|
* </note>
|
|
71
|
-
* <p>If the configuration in the request body includes only one
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
* <p>The following action is related to
|
|
77
|
-
* <code>PutBucketNotificationConfiguration</code>:</p>
|
|
67
|
+
* <p>If the configuration in the request body includes only one <code>TopicConfiguration</code>
|
|
68
|
+
* specifying only the <code>s3:ReducedRedundancyLostObject</code> event type, the response will also
|
|
69
|
+
* include the <code>x-amz-sns-test-message-id</code> header containing the message ID of the test
|
|
70
|
+
* notification sent to the topic.</p>
|
|
71
|
+
* <p>The following action is related to <code>PutBucketNotificationConfiguration</code>:</p>
|
|
78
72
|
* <ul>
|
|
79
73
|
* <li>
|
|
80
74
|
* <p>
|
|
@@ -30,12 +30,10 @@ declare const PutBucketOwnershipControlsCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html">Using object
|
|
38
|
-
* ownership</a>. </p>
|
|
33
|
+
* <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
|
|
34
|
+
* must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information about Amazon S3
|
|
35
|
+
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a policy</a>. </p>
|
|
36
|
+
* <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html">Using object ownership</a>. </p>
|
|
39
37
|
* <p>The following operations are related to <code>PutBucketOwnershipControls</code>:</p>
|
|
40
38
|
* <ul>
|
|
41
39
|
* <li>
|
|
@@ -39,51 +39,46 @@ declare const PutBucketPolicyCommand_base: {
|
|
|
39
39
|
* <dl>
|
|
40
40
|
* <dt>Permissions</dt>
|
|
41
41
|
* <dd>
|
|
42
|
-
* <p>If you are using an identity other than the root user of the Amazon Web Services account that
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
* returns a <code>405 Method Not Allowed</code> error.</p>
|
|
42
|
+
* <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the
|
|
43
|
+
* bucket, the calling identity must both have the <code>PutBucketPolicy</code> permissions on the
|
|
44
|
+
* specified bucket and belong to 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 <code>403 Access
|
|
46
|
+
* Denied</code> error. If you have the correct permissions, but you're not using an identity that
|
|
47
|
+
* belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code>
|
|
48
|
+
* error.</p>
|
|
50
49
|
* <important>
|
|
51
|
-
* <p>To ensure that bucket owners don't inadvertently lock themselves out of
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* Amazon Web Services Organizations policies.</p>
|
|
50
|
+
* <p>To ensure that bucket owners don't inadvertently lock themselves out of their own buckets,
|
|
51
|
+
* the root principal in a bucket owner's Amazon Web Services account can perform the
|
|
52
|
+
* <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
|
|
53
|
+
* <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly denies the
|
|
54
|
+
* root principal's access. Bucket owner root principals can only be blocked from performing these
|
|
55
|
+
* API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
|
|
58
56
|
* </important>
|
|
59
57
|
* <ul>
|
|
60
58
|
* <li>
|
|
61
59
|
* <p>
|
|
62
60
|
* <b>General purpose bucket permissions</b> - The
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
61
|
+
* <code>s3:PutBucketPolicy</code> permission is required in a policy. For more information
|
|
62
|
+
* 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
|
|
63
|
+
* Policies</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
66
64
|
* </li>
|
|
67
65
|
* <li>
|
|
68
66
|
* <p>
|
|
69
|
-
* <b>Directory bucket permissions</b> -
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* 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>
|
|
67
|
+
* <b>Directory bucket permissions</b> - To grant access to
|
|
68
|
+
* this API operation, you must have the <code>s3express:PutBucketPolicy</code> permission in
|
|
69
|
+
* 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.
|
|
70
|
+
* 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>
|
|
74
71
|
* </li>
|
|
75
72
|
* </ul>
|
|
76
73
|
* </dd>
|
|
77
74
|
* <dt>Example bucket policies</dt>
|
|
78
75
|
* <dd>
|
|
79
76
|
* <p>
|
|
80
|
-
* <b>General purpose buckets example bucket policies</b>
|
|
81
|
-
*
|
|
82
|
-
* examples</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
77
|
+
* <b>General purpose buckets example bucket policies</b> - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
|
|
78
|
+
* examples</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
83
79
|
* <p>
|
|
84
|
-
* <b>Directory bucket example bucket policies</b>
|
|
85
|
-
*
|
|
86
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
80
|
+
* <b>Directory bucket example bucket policies</b> - See <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example
|
|
81
|
+
* bucket policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
87
82
|
* </dd>
|
|
88
83
|
* <dt>HTTP Host header syntax</dt>
|
|
89
84
|
* <dd>
|
|
@@ -30,60 +30,53 @@ declare const PutBucketReplicationCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p> Creates a replication configuration or replaces an existing one. For more information,
|
|
34
|
-
*
|
|
35
|
-
* <p>Specify the replication configuration in the request body. In the replication
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* Region by using the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion">
|
|
33
|
+
* <p> Creates a replication configuration or replaces an existing one. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the
|
|
34
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
35
|
+
* <p>Specify the replication configuration in the request body. In the replication configuration, you
|
|
36
|
+
* provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the
|
|
37
|
+
* IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. You
|
|
38
|
+
* can invoke this request for a specific Amazon Web Services Region by using the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion">
|
|
40
39
|
* <code>aws:RequestedRegion</code>
|
|
41
40
|
* </a> condition key.</p>
|
|
42
|
-
* <p>A replication configuration must include at least one rule, and can contain a maximum of
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* <code>DeleteMarkerReplication</code>, <code>Status</code>, and
|
|
51
|
-
* <code>Priority</code>.</p>
|
|
41
|
+
* <p>A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each
|
|
42
|
+
* rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To
|
|
43
|
+
* choose additional subsets of objects to replicate, add a rule for each subset.</p>
|
|
44
|
+
* <p>To specify a subset of the objects in the source bucket to apply a replication rule to, add the
|
|
45
|
+
* Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one
|
|
46
|
+
* or more object tags, or both. When you add the Filter element in the configuration, you must also add
|
|
47
|
+
* the following elements: <code>DeleteMarkerReplication</code>, <code>Status</code>, and
|
|
48
|
+
* <code>Priority</code>.</p>
|
|
52
49
|
* <note>
|
|
53
|
-
* <p>If you are using an earlier version of the replication configuration, Amazon S3 handles
|
|
54
|
-
*
|
|
50
|
+
* <p>If you are using an earlier version of the replication configuration, Amazon S3 handles replication of
|
|
51
|
+
* delete markers differently. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations">Backward Compatibility</a>.</p>
|
|
55
52
|
* </note>
|
|
56
53
|
* <p>For information about enabling versioning on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html">Using Versioning</a>.</p>
|
|
57
54
|
* <dl>
|
|
58
55
|
* <dt>Handling Replication of Encrypted Objects</dt>
|
|
59
56
|
* <dd>
|
|
60
|
-
* <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* Objects Created with SSE Using KMS keys</a>.</p>
|
|
57
|
+
* <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side
|
|
58
|
+
* encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:
|
|
59
|
+
* <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>, <code>Status</code>,
|
|
60
|
+
* <code>EncryptionConfiguration</code>, and <code>ReplicaKmsKeyID</code>. For information about
|
|
61
|
+
* replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects Created
|
|
62
|
+
* with SSE Using KMS keys</a>.</p>
|
|
67
63
|
* <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
|
|
68
|
-
*
|
|
64
|
+
* replication-related error codes</a>
|
|
69
65
|
* </p>
|
|
70
66
|
* </dd>
|
|
71
67
|
* <dt>Permissions</dt>
|
|
72
68
|
* <dd>
|
|
73
69
|
* <p>To create a <code>PutBucketReplication</code> request, you must have
|
|
74
|
-
*
|
|
70
|
+
* <code>s3:PutReplicationConfiguration</code> permissions for the bucket.
|
|
75
71
|
*
|
|
76
|
-
*
|
|
77
|
-
* <p>By default, a resource owner, in this case the Amazon Web Services account that created the
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
* Permissions to Your Amazon S3 Resources</a>.</p>
|
|
72
|
+
* </p>
|
|
73
|
+
* <p>By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can
|
|
74
|
+
* perform this operation. The resource owner can also grant others permissions to perform the
|
|
75
|
+
* operation. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a>
|
|
76
|
+
* and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
77
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
83
78
|
* <note>
|
|
84
|
-
* <p>To perform this operation, the user or role performing the action must have
|
|
85
|
-
* the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a>
|
|
86
|
-
* permission.</p>
|
|
79
|
+
* <p>To perform this operation, the user or role performing the action must have the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission.</p>
|
|
87
80
|
* </note>
|
|
88
81
|
* </dd>
|
|
89
82
|
* </dl>
|
|
@@ -30,11 +30,10 @@ declare const PutBucketRequestPaymentCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Sets the request payment configuration for a bucket. By default, the bucket owner pays
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* Buckets</a>.</p>
|
|
33
|
+
* <p>Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads
|
|
34
|
+
* from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person
|
|
35
|
+
* requesting the download will be charged for the download. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
|
|
36
|
+
* Buckets</a>.</p>
|
|
38
37
|
* <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p>
|
|
39
38
|
* <ul>
|
|
40
39
|
* <li>
|
|
@@ -31,48 +31,42 @@ declare const PutBucketTaggingCommand_base: {
|
|
|
31
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
|
-
* <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html">Using Cost Allocation in Amazon S3
|
|
41
|
-
* Bucket Tags</a>.</p>
|
|
34
|
+
* <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get
|
|
35
|
+
* your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources,
|
|
36
|
+
* organize your billing information according to resources with the same tag key values. For example, you
|
|
37
|
+
* can tag several resources with a specific application name, and then organize your billing information
|
|
38
|
+
* to see the total cost of that application across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation and
|
|
39
|
+
* Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket Tags</a>.</p>
|
|
42
40
|
* <note>
|
|
43
|
-
* <p> When this operation sets the tags for a bucket, it will overwrite any current tags
|
|
44
|
-
*
|
|
45
|
-
* tags.</p>
|
|
41
|
+
* <p> When this operation sets the tags for a bucket, it will overwrite any current tags the bucket
|
|
42
|
+
* already has. You cannot use this operation to add tags to an existing list of tags.</p>
|
|
46
43
|
* </note>
|
|
47
|
-
* <p>To use this operation, you must have permissions to perform the
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
44
|
+
* <p>To use this operation, you must have permissions to perform the <code>s3:PutBucketTagging</code>
|
|
45
|
+
* action. The bucket owner has this permission by default and can grant this permission to others. For
|
|
46
|
+
* more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
47
|
+
* Resources</a>.</p>
|
|
51
48
|
* <p>
|
|
52
|
-
* <code>PutBucketTagging</code> has the following special errors. For more Amazon S3 errors
|
|
53
|
-
* see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
|
|
54
|
-
* Responses</a>.</p>
|
|
49
|
+
* <code>PutBucketTagging</code> has the following special errors. For more Amazon S3 errors see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error Responses</a>.</p>
|
|
55
50
|
* <ul>
|
|
56
51
|
* <li>
|
|
57
52
|
* <p>
|
|
58
|
-
* <code>InvalidTag</code> - The tag provided was not a valid tag. This error
|
|
59
|
-
*
|
|
60
|
-
*
|
|
53
|
+
* <code>InvalidTag</code> - The tag provided was not a valid tag. This error can occur if
|
|
54
|
+
* the tag did not pass input validation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket
|
|
55
|
+
* Tags</a>.</p>
|
|
61
56
|
* </li>
|
|
62
57
|
* <li>
|
|
63
58
|
* <p>
|
|
64
|
-
* <code>MalformedXML</code> - The XML provided does not match the
|
|
65
|
-
* schema.</p>
|
|
59
|
+
* <code>MalformedXML</code> - The XML provided does not match the schema.</p>
|
|
66
60
|
* </li>
|
|
67
61
|
* <li>
|
|
68
62
|
* <p>
|
|
69
|
-
* <code>OperationAborted</code> - A conflicting conditional action is
|
|
70
|
-
*
|
|
63
|
+
* <code>OperationAborted</code> - A conflicting conditional action is currently in progress
|
|
64
|
+
* against this resource. Please try again.</p>
|
|
71
65
|
* </li>
|
|
72
66
|
* <li>
|
|
73
67
|
* <p>
|
|
74
|
-
* <code>InternalError</code> - The service was unable to apply the provided
|
|
75
|
-
*
|
|
68
|
+
* <code>InternalError</code> - The service was unable to apply the provided tag to the
|
|
69
|
+
* bucket.</p>
|
|
76
70
|
* </li>
|
|
77
71
|
* </ul>
|
|
78
72
|
* <p>The following operations are related to <code>PutBucketTagging</code>:</p>
|
|
@@ -31,35 +31,32 @@ declare const PutBucketVersioningCommand_base: {
|
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <note>
|
|
34
|
-
* <p>When you enable versioning on a bucket for the first time, it might take a short
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* <code>DELETE</code>) on objects in the bucket. </p>
|
|
34
|
+
* <p>When you enable versioning on a bucket for the first time, it might take a short amount of time
|
|
35
|
+
* for the change to be fully propagated. While this change is propagating, you might encounter
|
|
36
|
+
* intermittent <code>HTTP 404 NoSuchKey</code> errors for requests to objects created or updated after
|
|
37
|
+
* enabling versioning. We recommend that you wait for 15 minutes after enabling versioning before
|
|
38
|
+
* issuing write operations (<code>PUT</code> or <code>DELETE</code>) on objects in the bucket. </p>
|
|
40
39
|
* </note>
|
|
41
40
|
* <p>Sets the versioning state of an existing bucket.</p>
|
|
42
41
|
* <p>You can set the versioning state with one of the following values:</p>
|
|
43
42
|
* <p>
|
|
44
|
-
* <b>Enabled</b>—Enables versioning for the objects in the
|
|
45
|
-
*
|
|
43
|
+
* <b>Enabled</b>—Enables versioning for the objects in the bucket. All
|
|
44
|
+
* objects added to the bucket receive a unique version ID.</p>
|
|
46
45
|
* <p>
|
|
47
|
-
* <b>Suspended</b>—Disables versioning for the objects in the
|
|
48
|
-
*
|
|
49
|
-
* <p>If the versioning state has never been set on a bucket, it has no versioning state; a
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
* <code>MfaDelete</code> request elements in a request to set the versioning state of the
|
|
55
|
-
* bucket.</p>
|
|
46
|
+
* <b>Suspended</b>—Disables versioning for the objects in the bucket. All
|
|
47
|
+
* objects added to the bucket receive the version ID null.</p>
|
|
48
|
+
* <p>If the versioning state has never been set on a bucket, it has no versioning state; a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> request does not return a versioning state value.</p>
|
|
49
|
+
* <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to
|
|
50
|
+
* enable MFA Delete in the bucket versioning configuration, you must include the <code>x-amz-mfa
|
|
51
|
+
* request</code> header and the <code>Status</code> and the <code>MfaDelete</code> request elements in a
|
|
52
|
+
* request to set the versioning state of the bucket.</p>
|
|
56
53
|
* <important>
|
|
57
|
-
* <p>If you have an object expiration lifecycle configuration in your non-versioned bucket
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
54
|
+
* <p>If you have an object expiration lifecycle configuration in your non-versioned bucket and you want
|
|
55
|
+
* to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent
|
|
56
|
+
* expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the
|
|
57
|
+
* noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one
|
|
58
|
+
* current and zero or more noncurrent object versions.) For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config">Lifecycle and
|
|
59
|
+
* Versioning</a>.</p>
|
|
63
60
|
* </important>
|
|
64
61
|
* <p>The following operations are related to <code>PutBucketVersioning</code>:</p>
|
|
65
62
|
* <ul>
|
|
@@ -30,17 +30,18 @@ declare const PutBucketWebsiteCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This operation is not supported for directory buckets.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Sets the configuration of the website that is specified in the <code>website</code>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* website
|
|
43
|
-
*
|
|
33
|
+
* <p>Sets the configuration of the website that is specified in the <code>website</code> subresource. To
|
|
34
|
+
* configure a bucket as a website, you can add this subresource on the bucket with website configuration
|
|
35
|
+
* information such as the file name of the index document and any redirect rules. For more information,
|
|
36
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on
|
|
37
|
+
* Amazon S3</a>.</p>
|
|
38
|
+
* <p>This PUT action requires the <code>S3:PutBucketWebsite</code> permission. By default, only the
|
|
39
|
+
* bucket owner can configure the website attached to a bucket; however, bucket owners can allow other
|
|
40
|
+
* users to set the website configuration by writing a bucket policy that grants them the
|
|
41
|
+
* <code>S3:PutBucketWebsite</code> permission.</p>
|
|
42
|
+
* <p>To redirect all website requests sent to the bucket's website endpoint, you add a website
|
|
43
|
+
* configuration with the following elements. Because all requests are sent to another website, you don't
|
|
44
|
+
* need to provide index document name for the bucket.</p>
|
|
44
45
|
* <ul>
|
|
45
46
|
* <li>
|
|
46
47
|
* <p>
|
|
@@ -63,10 +64,10 @@ declare const PutBucketWebsiteCommand_base: {
|
|
|
63
64
|
* </p>
|
|
64
65
|
* </li>
|
|
65
66
|
* </ul>
|
|
66
|
-
* <p>If you want granular control over redirects, you can use the following elements to add
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
67
|
+
* <p>If you want granular control over redirects, you can use the following elements to add routing rules
|
|
68
|
+
* that describe conditions for redirecting requests and information about the redirect destination. In
|
|
69
|
+
* this case, the website configuration must provide an index document for the bucket, because some
|
|
70
|
+
* requests might not be redirected. </p>
|
|
70
71
|
* <ul>
|
|
71
72
|
* <li>
|
|
72
73
|
* <p>
|
|
@@ -149,9 +150,9 @@ declare const PutBucketWebsiteCommand_base: {
|
|
|
149
150
|
* </p>
|
|
150
151
|
* </li>
|
|
151
152
|
* </ul>
|
|
152
|
-
* <p>Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more
|
|
153
|
-
*
|
|
154
|
-
*
|
|
153
|
+
* <p>Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50
|
|
154
|
+
* routing rules, you can use object redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">Configuring an Object Redirect</a> in the
|
|
155
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
155
156
|
* <p>The maximum request length is limited to 128 KB.</p>
|
|
156
157
|
* @example
|
|
157
158
|
* Use a bare-bones client and the command you need to make an API call.
|