@aws-sdk/client-s3 3.326.0 → 3.327.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-types/commands/AbortMultipartUploadCommand.d.ts +2 -2
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +22 -14
- package/dist-types/commands/CopyObjectCommand.d.ts +171 -144
- package/dist-types/commands/CreateBucketCommand.d.ts +128 -118
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +73 -48
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketCommand.d.ts +1 -3
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +3 -5
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +8 -8
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +1 -2
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +6 -3
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -3
- package/dist-types/commands/DeleteObjectCommand.d.ts +21 -21
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +13 -15
- package/dist-types/commands/DeleteObjectsCommand.d.ts +35 -36
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +6 -7
- package/dist-types/commands/GetBucketAclCommand.d.ts +14 -10
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +6 -7
- package/dist-types/commands/GetBucketCorsCommand.d.ts +5 -0
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +7 -7
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/GetBucketLocationCommand.d.ts +10 -2
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +5 -6
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -2
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +4 -3
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +11 -3
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -1
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +2 -3
- package/dist-types/commands/GetObjectAclCommand.d.ts +5 -7
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +42 -45
- package/dist-types/commands/GetObjectCommand.d.ts +116 -112
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +2 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +5 -5
- 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 +19 -9
- package/dist-types/commands/HeadObjectCommand.d.ts +36 -33
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +4 -4
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -2
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +5 -5
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +6 -7
- package/dist-types/commands/ListBucketsCommand.d.ts +9 -7
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +2 -2
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +3 -6
- package/dist-types/commands/ListObjectsV2Command.d.ts +13 -14
- package/dist-types/commands/ListPartsCommand.d.ts +3 -4
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -3
- package/dist-types/commands/PutBucketAclCommand.d.ts +114 -111
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +7 -10
- package/dist-types/commands/PutBucketCorsCommand.d.ts +3 -5
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +17 -17
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +31 -59
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +50 -65
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +64 -62
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +45 -39
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -2
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +8 -4
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -28
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +12 -12
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +7 -9
- package/dist-types/commands/PutObjectAclCommand.d.ts +123 -119
- package/dist-types/commands/PutObjectCommand.d.ts +81 -90
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +3 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +7 -9
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +2 -4
- package/dist-types/commands/RestoreObjectCommand.d.ts +175 -199
- package/dist-types/commands/SelectObjectContentCommand.d.ts +83 -90
- package/dist-types/commands/UploadPartCommand.d.ts +26 -22
- package/dist-types/commands/UploadPartCopyCommand.d.ts +78 -76
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +32 -21
- package/dist-types/models/models_0.d.ts +468 -382
- package/dist-types/models/models_1.d.ts +82 -80
- package/package.json +7 -7
|
@@ -20,10 +20,10 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
|
|
23
|
-
* configuration. Keep in mind that this will overwrite an existing lifecycle configuration,
|
|
24
|
-
* you want to retain any configuration details, they must be included in the new
|
|
25
|
-
* configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing
|
|
26
|
-
* lifecycle</a>.</p>
|
|
23
|
+
* configuration. Keep in mind that this will overwrite an existing lifecycle configuration,
|
|
24
|
+
* so if you want to retain any configuration details, they must be included in the new
|
|
25
|
+
* lifecycle configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing
|
|
26
|
+
* your storage lifecycle</a>.</p>
|
|
27
27
|
* <note>
|
|
28
28
|
* <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an
|
|
29
29
|
* object key name prefix, one or more object tags, or a combination of both. Accordingly,
|
|
@@ -31,64 +31,66 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata
|
|
|
31
31
|
* filtering based only on an object key name prefix, which is supported for backward
|
|
32
32
|
* compatibility. For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>.</p>
|
|
33
33
|
* </note>
|
|
34
|
-
* <
|
|
35
|
-
* <
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
* <
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
34
|
+
* <dl>
|
|
35
|
+
* <dt>Rules</dt>
|
|
36
|
+
* <dd>
|
|
37
|
+
* <p>You specify the lifecycle configuration in your request body. The lifecycle
|
|
38
|
+
* configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle
|
|
39
|
+
* configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists
|
|
40
|
+
* of the following:</p>
|
|
41
|
+
* <ul>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>Filter identifying a subset of objects to which the rule applies. The filter can
|
|
44
|
+
* be based on a key name prefix, object tags, or a combination of both.</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>Status whether the rule is in effect.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>One or more lifecycle transition and expiration actions that you want Amazon S3 to
|
|
51
|
+
* perform on the objects identified by the filter. If the state of your bucket is
|
|
52
|
+
* versioning-enabled or versioning-suspended, you can have many versions of the same
|
|
53
|
+
* object (one current version and zero or more noncurrent versions). Amazon S3 provides
|
|
54
|
+
* predefined actions that you can specify for current and noncurrent object
|
|
55
|
+
* versions.</p>
|
|
56
|
+
* </li>
|
|
57
|
+
* </ul>
|
|
58
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>
|
|
59
|
+
* and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration Elements</a>.</p>
|
|
60
|
+
* </dd>
|
|
61
|
+
* <dt>Permissions</dt>
|
|
62
|
+
* <dd>
|
|
63
|
+
* <p>By default, all Amazon S3 resources are private, including buckets, objects, and related
|
|
64
|
+
* subresources (for example, lifecycle configuration and website configuration). Only the
|
|
65
|
+
* resource owner (that is, the Amazon Web Services account that created it) can access the resource. The
|
|
66
|
+
* resource owner can optionally grant access permissions to others by writing an access
|
|
67
|
+
* policy. For this operation, a user must get the <code>s3:PutLifecycleConfiguration</code>
|
|
68
|
+
* permission.</p>
|
|
69
|
+
* <p>You can also explicitly deny permissions. Explicit deny also supersedes any other
|
|
70
|
+
* permissions. If you want to block users or accounts from removing or deleting objects from
|
|
71
|
+
* your bucket, you must deny them permissions for the following actions:</p>
|
|
72
|
+
* <ul>
|
|
73
|
+
* <li>
|
|
74
|
+
* <p>
|
|
75
|
+
* <code>s3:DeleteObject</code>
|
|
76
|
+
* </p>
|
|
77
|
+
* </li>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>
|
|
80
|
+
* <code>s3:DeleteObjectVersion</code>
|
|
81
|
+
* </p>
|
|
82
|
+
* </li>
|
|
83
|
+
* <li>
|
|
84
|
+
* <p>
|
|
85
|
+
* <code>s3:PutLifecycleConfiguration</code>
|
|
86
|
+
* </p>
|
|
87
|
+
* </li>
|
|
88
|
+
* </ul>
|
|
89
|
+
* <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to
|
|
90
|
+
* Your Amazon S3 Resources</a>.</p>
|
|
91
|
+
* </dd>
|
|
92
|
+
* </dl>
|
|
93
|
+
* <p>The following operations are related to <code>PutBucketLifecycleConfiguration</code>:</p>
|
|
92
94
|
* <ul>
|
|
93
95
|
* <li>
|
|
94
96
|
* <p>
|
|
@@ -20,56 +20,62 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Set the logging parameters for a bucket and to specify permissions for who can view and
|
|
23
|
-
* modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as
|
|
24
|
-
* source bucket. To set the logging status of a bucket, you must be the bucket
|
|
25
|
-
*
|
|
23
|
+
* modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as
|
|
24
|
+
* the source bucket. To set the logging status of a bucket, you must be the bucket
|
|
25
|
+
* owner.</p>
|
|
26
|
+
* <p>The bucket owner is automatically granted FULL_CONTROL to all logs. You use the
|
|
27
|
+
* <code>Grantee</code> request element to grant access to other people. The
|
|
26
28
|
* <code>Permissions</code> request element specifies the kind of access the grantee has to
|
|
27
29
|
* the logs.</p>
|
|
28
30
|
* <important>
|
|
29
|
-
* <p>If the target bucket for log delivery uses the bucket owner enforced
|
|
30
|
-
*
|
|
31
|
-
* to
|
|
31
|
+
* <p>If the target bucket for log delivery uses the bucket owner enforced setting for S3
|
|
32
|
+
* Object Ownership, you can't use the <code>Grantee</code> request element to grant access
|
|
33
|
+
* to others. Permissions can only be granted using policies. For more information, see
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions for server access log delivery</a> in the
|
|
32
35
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
33
36
|
* </important>
|
|
34
|
-
* <
|
|
35
|
-
* <
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
37
|
+
* <dl>
|
|
38
|
+
* <dt>Grantee Values</dt>
|
|
39
|
+
* <dd>
|
|
40
|
+
* <p>You can specify the person (grantee) to whom you're assigning access rights (using
|
|
41
|
+
* request elements) in the following ways:</p>
|
|
42
|
+
* <ul>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>By the person's ID:</p>
|
|
45
|
+
* <p>
|
|
46
|
+
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
47
|
+
* xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
|
|
48
|
+
* </Grantee></code>
|
|
49
|
+
* </p>
|
|
50
|
+
* <p>DisplayName is optional and ignored in the request.</p>
|
|
51
|
+
* </li>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>By Email address:</p>
|
|
54
|
+
* <p>
|
|
55
|
+
* <code> <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
56
|
+
* xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></code>
|
|
57
|
+
* </p>
|
|
58
|
+
* <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object
|
|
59
|
+
* acl request, appears as the CanonicalUser.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>By URI:</p>
|
|
63
|
+
* <p>
|
|
64
|
+
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
65
|
+
* xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
|
|
66
|
+
* </p>
|
|
67
|
+
* </li>
|
|
68
|
+
* </ul>
|
|
69
|
+
* </dd>
|
|
70
|
+
* </dl>
|
|
66
71
|
* <p>To enable logging, you use LoggingEnabled and its children request elements. To disable
|
|
67
72
|
* logging, you use an empty BucketLoggingStatus request element:</p>
|
|
68
73
|
* <p>
|
|
69
74
|
* <code><BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01"
|
|
70
75
|
* /></code>
|
|
71
76
|
* </p>
|
|
72
|
-
* <p>For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server Access Logging</a> in the
|
|
77
|
+
* <p>For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server Access Logging</a> in the
|
|
78
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
73
79
|
* <p>For more information about creating a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. For more
|
|
74
80
|
* information about returning the logging status of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a>.</p>
|
|
75
81
|
* <p>The following operations are related to <code>PutBucketLogging</code>:</p>
|
|
@@ -26,10 +26,10 @@ export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBe
|
|
|
26
26
|
* <p>To use this operation, you must have permissions to perform the
|
|
27
27
|
* <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
28
28
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
29
|
-
* 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
|
|
30
|
-
* Resources</a>.</p>
|
|
31
|
-
* <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
|
|
32
|
-
* CloudWatch</a>.</p>
|
|
29
|
+
* 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
|
|
30
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
31
|
+
* <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
|
|
32
|
+
* Metrics with Amazon CloudWatch</a>.</p>
|
|
33
33
|
* <p>The following operations are related to
|
|
34
34
|
* <code>PutBucketMetricsConfiguration</code>:</p>
|
|
35
35
|
* <ul>
|
|
@@ -21,7 +21,7 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Enables notifications of specified events for a bucket. For more information about event
|
|
23
23
|
* notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event
|
|
24
|
-
*
|
|
24
|
+
* Notifications</a>.</p>
|
|
25
25
|
* <p>Using this API, you can replace an existing notification configuration. The
|
|
26
26
|
* configuration is an XML file that defines the event types that you want Amazon S3 to publish and
|
|
27
27
|
* the destination where you want Amazon S3 to publish an event notification when it detects an
|
|
@@ -34,19 +34,19 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
|
|
|
34
34
|
* <p>
|
|
35
35
|
* <code></NotificationConfiguration></code>
|
|
36
36
|
* </p>
|
|
37
|
-
* <p>This action replaces the existing notification configuration with the configuration
|
|
38
|
-
*
|
|
37
|
+
* <p>This action replaces the existing notification configuration with the configuration you
|
|
38
|
+
* include in the request body.</p>
|
|
39
39
|
* <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification
|
|
40
40
|
* Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and
|
|
41
41
|
* that the bucket owner has permission to publish to it by sending a test notification. In
|
|
42
42
|
* the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions
|
|
43
43
|
* grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,
|
|
44
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3
|
|
45
|
-
* Events</a>.</p>
|
|
44
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3 Events</a>.</p>
|
|
46
45
|
* <p>You can disable notifications by adding the empty NotificationConfiguration
|
|
47
46
|
* element.</p>
|
|
48
|
-
* <p>For more information about the number of event notification configurations that you can
|
|
49
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service quotas</a> in <i>Amazon Web Services
|
|
47
|
+
* <p>For more information about the number of event notification configurations that you can
|
|
48
|
+
* create per bucket, see <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service quotas</a> in <i>Amazon Web Services
|
|
49
|
+
* General Reference</i>.</p>
|
|
50
50
|
* <p>By default, only the bucket owner can configure notifications on a bucket. However,
|
|
51
51
|
* bucket owners can use a bucket policy to grant permission to other users to set this
|
|
52
52
|
* configuration with <code>s3:PutBucketNotification</code> permission.</p>
|
|
@@ -54,12 +54,9 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
|
|
|
54
54
|
* <p>The PUT notification is an atomic operation. For example, suppose your notification
|
|
55
55
|
* configuration includes SNS topic, SQS queue, and Lambda function configurations. When
|
|
56
56
|
* you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS
|
|
57
|
-
* topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add
|
|
58
|
-
*
|
|
57
|
+
* topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the
|
|
58
|
+
* configuration to your bucket.</p>
|
|
59
59
|
* </note>
|
|
60
|
-
* <p>
|
|
61
|
-
* <b>Responses</b>
|
|
62
|
-
* </p>
|
|
63
60
|
* <p>If the configuration in the request body includes only one
|
|
64
61
|
* <code>TopicConfiguration</code> specifying only the
|
|
65
62
|
* <code>s3:ReducedRedundancyLostObject</code> event type, the response will also include
|
|
@@ -21,8 +21,10 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this
|
|
23
23
|
* operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For
|
|
24
|
-
* more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a
|
|
25
|
-
*
|
|
24
|
+
* more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a
|
|
25
|
+
* policy</a>. </p>
|
|
26
|
+
* <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
|
|
27
|
+
* ownership</a>. </p>
|
|
26
28
|
* <p>The following operations are related to <code>PutBucketOwnershipControls</code>:</p>
|
|
27
29
|
* <ul>
|
|
28
30
|
* <li>
|
|
@@ -28,11 +28,15 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
|
|
|
28
28
|
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not
|
|
29
29
|
* Allowed</code> error.</p>
|
|
30
30
|
* <important>
|
|
31
|
-
* <p>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
31
|
+
* <p>To ensure that bucket owners don't inadvertently lock themselves out of their own
|
|
32
|
+
* buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
|
|
33
|
+
* <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
|
|
34
|
+
* <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
|
|
35
|
+
* denies the root principal's access. Bucket owner root principals can only be blocked from performing
|
|
36
|
+
* these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
|
|
34
37
|
* </important>
|
|
35
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
|
|
38
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
|
|
39
|
+
* examples</a>.</p>
|
|
36
40
|
* <p>The following operations are related to <code>PutBucketPolicy</code>:</p>
|
|
37
41
|
* <ul>
|
|
38
42
|
* <li>
|
|
@@ -40,34 +40,37 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* replication of 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>
|
|
41
41
|
* </note>
|
|
42
42
|
* <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>
|
|
43
|
-
* <
|
|
44
|
-
* <
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* <
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
43
|
+
* <dl>
|
|
44
|
+
* <dt>Handling Replication of Encrypted Objects</dt>
|
|
45
|
+
* <dd>
|
|
46
|
+
* <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side
|
|
47
|
+
* encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:
|
|
48
|
+
* <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>,
|
|
49
|
+
* <code>Status</code>, <code>EncryptionConfiguration</code>, and
|
|
50
|
+
* <code>ReplicaKmsKeyID</code>. For information about replication configuration, see
|
|
51
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects
|
|
52
|
+
* Created with SSE Using KMS keys</a>.</p>
|
|
53
|
+
* <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
|
|
54
|
+
* replication-related error codes</a>
|
|
55
|
+
* </p>
|
|
56
|
+
* </dd>
|
|
57
|
+
* <dt>Permissions</dt>
|
|
58
|
+
* <dd>
|
|
59
|
+
* <p>To create a <code>PutBucketReplication</code> request, you must have
|
|
60
|
+
* <code>s3:PutReplicationConfiguration</code> permissions for the bucket.
|
|
61
|
+
*
|
|
62
|
+
* </p>
|
|
63
|
+
* <p>By default, a resource owner, in this case the Amazon Web Services account that created the bucket,
|
|
64
|
+
* can perform this operation. The resource owner can also grant others permissions to perform
|
|
65
|
+
* the 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
|
|
66
|
+
* Policy</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to
|
|
67
|
+
* Your Amazon S3 Resources</a>.</p>
|
|
68
|
+
* <note>
|
|
69
|
+
* <p>To perform this operation, the user or role performing the action must have the
|
|
70
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission.</p>
|
|
71
|
+
* </note>
|
|
72
|
+
* </dd>
|
|
73
|
+
* </dl>
|
|
71
74
|
* <p>The following operations are related to <code>PutBucketReplication</code>:</p>
|
|
72
75
|
* <ul>
|
|
73
76
|
* <li>
|
|
@@ -23,7 +23,7 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
|
|
|
23
23
|
* for downloads from the bucket. This configuration parameter enables the bucket owner (only)
|
|
24
24
|
* to specify that the person requesting the download will be charged for the download. For
|
|
25
25
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
|
|
26
|
-
*
|
|
26
|
+
* Buckets</a>.</p>
|
|
27
27
|
* <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p>
|
|
28
28
|
* <ul>
|
|
29
29
|
* <li>
|
|
@@ -20,23 +20,23 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Sets the tags for a bucket.</p>
|
|
23
|
-
* <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
|
|
24
|
-
* up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost
|
|
25
|
-
* combined resources, organize your billing information according to resources with the
|
|
26
|
-
* tag key values. For example, you can tag several resources with a specific application
|
|
23
|
+
* <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
|
|
24
|
+
* sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost
|
|
25
|
+
* of combined resources, organize your billing information according to resources with the
|
|
26
|
+
* same tag key values. For example, you can tag several resources with a specific application
|
|
27
27
|
* name, and then organize your billing information to see the total cost of that application
|
|
28
|
-
* across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation and
|
|
29
|
+
* Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket
|
|
30
|
+
* Tags</a>.</p>
|
|
31
31
|
* <note>
|
|
32
|
-
* <p>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
32
|
+
* <p> When this operation sets the tags for a bucket, it will overwrite any current tags
|
|
33
|
+
* the bucket already has. You cannot use this operation to add tags to an existing list of
|
|
34
|
+
* tags.</p>
|
|
35
35
|
* </note>
|
|
36
36
|
* <p>To use this operation, you must have permissions to perform the
|
|
37
37
|
* <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default
|
|
38
|
-
* and 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
|
|
39
|
-
* Resources</a>.</p>
|
|
38
|
+
* and 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
|
|
39
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
40
40
|
* <p>
|
|
41
41
|
* <code>PutBucketTagging</code> has the following special errors:</p>
|
|
42
42
|
* <ul>
|
|
@@ -30,21 +30,19 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {
|
|
|
30
30
|
* <p>If the versioning state has never been set on a bucket, it has no versioning state; a
|
|
31
31
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> request does not return a versioning state value.</p>
|
|
32
32
|
* <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner
|
|
33
|
-
* and want to enable MFA Delete in the bucket versioning configuration, you must
|
|
34
|
-
*
|
|
35
|
-
* <code>
|
|
36
|
-
*
|
|
33
|
+
* and want to enable MFA Delete in the bucket versioning configuration, you must include the
|
|
34
|
+
* <code>x-amz-mfa request</code> header and the <code>Status</code> and the
|
|
35
|
+
* <code>MfaDelete</code> request elements in a request to set the versioning state of the
|
|
36
|
+
* bucket.</p>
|
|
37
37
|
* <important>
|
|
38
|
-
* <p>If you have an object expiration lifecycle
|
|
38
|
+
* <p>If you have an object expiration lifecycle configuration in your non-versioned bucket and
|
|
39
39
|
* you want to maintain the same permanent delete behavior when you enable versioning, you
|
|
40
|
-
* must add a noncurrent expiration policy. The noncurrent expiration lifecycle
|
|
40
|
+
* must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will
|
|
41
41
|
* manage the deletes of the noncurrent object versions in the version-enabled bucket. (A
|
|
42
42
|
* version-enabled bucket maintains one current and zero or more noncurrent object
|
|
43
43
|
* 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 Versioning</a>.</p>
|
|
44
44
|
* </important>
|
|
45
|
-
* <p
|
|
46
|
-
* <b>Related Resources</b>
|
|
47
|
-
* </p>
|
|
45
|
+
* <p>The following operations are related to <code>PutBucketVersioning</code>:</p>
|
|
48
46
|
* <ul>
|
|
49
47
|
* <li>
|
|
50
48
|
* <p>
|