@aws-sdk/client-s3 3.325.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.
Files changed (96) hide show
  1. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +8 -2
  2. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +41 -14
  3. package/dist-types/commands/CopyObjectCommand.d.ts +194 -144
  4. package/dist-types/commands/CreateBucketCommand.d.ts +134 -118
  5. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +91 -48
  6. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +6 -2
  7. package/dist-types/commands/DeleteBucketCommand.d.ts +5 -3
  8. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +7 -5
  9. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +12 -8
  10. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +5 -2
  11. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +6 -2
  12. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +5 -2
  13. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -5
  14. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +6 -2
  15. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +10 -3
  16. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +8 -3
  17. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteObjectCommand.d.ts +19 -11
  20. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +8 -4
  21. package/dist-types/commands/DeleteObjectsCommand.d.ts +57 -36
  22. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -2
  23. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +12 -7
  24. package/dist-types/commands/GetBucketAclCommand.d.ts +35 -10
  25. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +43 -7
  26. package/dist-types/commands/GetBucketCorsCommand.d.ts +28 -0
  27. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +23 -7
  28. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +32 -2
  29. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +35 -2
  30. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +62 -4
  31. package/dist-types/commands/GetBucketLocationCommand.d.ts +16 -2
  32. package/dist-types/commands/GetBucketLoggingCommand.d.ts +22 -1
  33. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +31 -6
  34. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +70 -2
  35. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +16 -3
  36. package/dist-types/commands/GetBucketPolicyCommand.d.ts +17 -3
  37. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +9 -1
  38. package/dist-types/commands/GetBucketReplicationCommand.d.ts +69 -0
  39. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +8 -1
  40. package/dist-types/commands/GetBucketTaggingCommand.d.ts +11 -0
  41. package/dist-types/commands/GetBucketVersioningCommand.d.ts +7 -0
  42. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +32 -3
  43. package/dist-types/commands/GetObjectAclCommand.d.ts +27 -7
  44. package/dist-types/commands/GetObjectAttributesCommand.d.ts +77 -45
  45. package/dist-types/commands/GetObjectCommand.d.ts +159 -112
  46. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +8 -0
  47. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +16 -2
  48. package/dist-types/commands/GetObjectRetentionCommand.d.ts +11 -1
  49. package/dist-types/commands/GetObjectTaggingCommand.d.ts +17 -5
  50. package/dist-types/commands/GetObjectTorrentCommand.d.ts +8 -1
  51. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +12 -1
  52. package/dist-types/commands/HeadBucketCommand.d.ts +23 -9
  53. package/dist-types/commands/HeadObjectCommand.d.ts +77 -33
  54. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +46 -4
  55. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +37 -2
  56. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +43 -5
  57. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +37 -7
  58. package/dist-types/commands/ListBucketsCommand.d.ts +18 -32
  59. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +39 -2
  60. package/dist-types/commands/ListObjectVersionsCommand.d.ts +53 -6
  61. package/dist-types/commands/ListObjectsCommand.d.ts +34 -0
  62. package/dist-types/commands/ListObjectsV2Command.d.ts +47 -12
  63. package/dist-types/commands/ListPartsCommand.d.ts +40 -4
  64. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +8 -3
  65. package/dist-types/commands/PutBucketAclCommand.d.ts +118 -111
  66. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +11 -10
  67. package/dist-types/commands/PutBucketCorsCommand.d.ts +7 -5
  68. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +21 -17
  69. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +35 -59
  70. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +54 -65
  71. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +68 -62
  72. package/dist-types/commands/PutBucketLoggingCommand.d.ts +49 -39
  73. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +8 -4
  74. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +13 -12
  75. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +8 -2
  76. package/dist-types/commands/PutBucketPolicyCommand.d.ts +12 -4
  77. package/dist-types/commands/PutBucketReplicationCommand.d.ts +35 -28
  78. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +5 -1
  79. package/dist-types/commands/PutBucketTaggingCommand.d.ts +16 -12
  80. package/dist-types/commands/PutBucketVersioningCommand.d.ts +11 -9
  81. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +4 -0
  82. package/dist-types/commands/PutObjectAclCommand.d.ts +129 -119
  83. package/dist-types/commands/PutObjectCommand.d.ts +94 -84
  84. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +6 -0
  85. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +13 -8
  86. package/dist-types/commands/PutObjectRetentionCommand.d.ts +9 -4
  87. package/dist-types/commands/PutObjectTaggingCommand.d.ts +13 -9
  88. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +6 -4
  89. package/dist-types/commands/RestoreObjectCommand.d.ts +182 -199
  90. package/dist-types/commands/SelectObjectContentCommand.d.ts +109 -90
  91. package/dist-types/commands/UploadPartCommand.d.ts +42 -22
  92. package/dist-types/commands/UploadPartCopyCommand.d.ts +85 -63
  93. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +36 -21
  94. package/dist-types/models/models_0.d.ts +468 -382
  95. package/dist-types/models/models_1.d.ts +82 -80
  96. package/package.json +9 -9
@@ -32,75 +32,60 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata
32
32
  * the <i>destination</i> bucket where you want the inventory to be stored, and
33
33
  * whether to generate the inventory daily or weekly. You can also configure what object
34
34
  * metadata to include and whether to inventory all object versions or only current versions.
35
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3
36
- * Inventory</a> in the Amazon S3 User Guide.</p>
35
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a> in the
36
+ * Amazon S3 User Guide.</p>
37
37
  * <important>
38
38
  * <p>You must create a bucket policy on the <i>destination</i> bucket to
39
39
  * grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an
40
- * example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">
41
- * Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p>
40
+ * example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9"> Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p>
42
41
  * </important>
43
- * <p>To use this operation, you must have permissions to perform the
44
- * <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission
45
- * by default and can grant this permission to others. For more information about permissions,
46
- * 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> in the Amazon S3 User Guide.</p>
48
- * <p class="title">
49
- * <b>Special Errors</b>
50
- * </p>
51
- * <ul>
52
- * <li>
53
- * <p class="title">
54
- * <b>HTTP 400 Bad Request Error</b>
55
- * </p>
56
- * <ul>
57
- * <li>
58
- * <p>
59
- * <i>Code:</i> InvalidArgument</p>
60
- * </li>
61
- * <li>
62
- * <p>
63
- * <i>Cause:</i> Invalid Argument</p>
64
- * </li>
65
- * </ul>
66
- * </li>
67
- * <li>
68
- * <p class="title">
69
- * <b>HTTP 400 Bad Request Error</b>
70
- * </p>
71
- * <ul>
72
- * <li>
73
- * <p>
74
- * <i>Code:</i> TooManyConfigurations</p>
75
- * </li>
76
- * <li>
77
- * <p>
78
- * <i>Cause:</i> You are attempting to create a new configuration
79
- * but have already reached the 1,000-configuration limit. </p>
80
- * </li>
81
- * </ul>
82
- * </li>
83
- * <li>
84
- * <p class="title">
85
- * <b>HTTP 403 Forbidden Error</b>
86
- * </p>
87
- * <ul>
88
- * <li>
89
- * <p>
90
- * <i>Code:</i> AccessDenied</p>
91
- * </li>
92
- * <li>
93
- * <p>
94
- * <i>Cause:</i> You are not the owner of the specified bucket,
95
- * or you do not have the <code>s3:PutInventoryConfiguration</code> bucket
96
- * permission to set the configuration on the bucket. </p>
97
- * </li>
98
- * </ul>
99
- * </li>
100
- * </ul>
101
- * <p class="title">
102
- * <b>Related Resources</b>
103
- * </p>
42
+ * <dl>
43
+ * <dt>Permissions</dt>
44
+ * <dd>
45
+ * <p>To use this operation, you must have permission to perform the
46
+ * <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission
47
+ * by default and can grant this permission to others. </p>
48
+ * <p>The <code>s3:PutInventoryConfiguration</code> permission allows a user to create an
49
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html">S3
50
+ * Inventory</a> report that includes all object metadata fields available and to
51
+ * specify the destination bucket to store the inventory. A user with read access to objects
52
+ * in the destination bucket can also access all object metadata fields that are available in
53
+ * the inventory report. </p>
54
+ * <p>To restrict access to an inventory report, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10">Restricting access to an Amazon S3 Inventory report</a> in the
55
+ * <i>Amazon S3 User Guide</i>. For more information about the metadata fields
56
+ * available in S3 Inventory, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents">Amazon S3
57
+ * Inventory lists</a> in the <i>Amazon S3 User Guide</i>. For more
58
+ * 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">Identity and
59
+ * access management in Amazon S3</a> in the <i>Amazon S3 User Guide</i>.</p>
60
+ * </dd>
61
+ * </dl>
62
+ * <p>
63
+ * <code>PutBucketInventoryConfiguration</code> has the following special errors:</p>
64
+ * <dl>
65
+ * <dt>HTTP 400 Bad Request Error</dt>
66
+ * <dd>
67
+ * <p>
68
+ * <i>Code:</i> InvalidArgument</p>
69
+ * <p>
70
+ * <i>Cause:</i> Invalid Argument</p>
71
+ * </dd>
72
+ * <dt>HTTP 400 Bad Request Error</dt>
73
+ * <dd>
74
+ * <p>
75
+ * <i>Code:</i> TooManyConfigurations</p>
76
+ * <p>
77
+ * <i>Cause:</i> You are attempting to create a new configuration
78
+ * but have already reached the 1,000-configuration limit. </p>
79
+ * </dd>
80
+ * <dt>HTTP 403 Forbidden Error</dt>
81
+ * <dd>
82
+ * <p>
83
+ * <i>Cause:</i> You are not the owner of the specified bucket,
84
+ * or you do not have the <code>s3:PutInventoryConfiguration</code> bucket
85
+ * permission to set the configuration on the bucket. </p>
86
+ * </dd>
87
+ * </dl>
88
+ * <p>The following operations are related to <code>PutBucketInventoryConfiguration</code>:</p>
104
89
  * <ul>
105
90
  * <li>
106
91
  * <p>
@@ -159,6 +144,8 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata
159
144
  * };
160
145
  * const command = new PutBucketInventoryConfigurationCommand(input);
161
146
  * const response = await client.send(command);
147
+ * // {};
148
+ *
162
149
  * ```
163
150
  *
164
151
  * @param PutBucketInventoryConfigurationCommandInput - {@link PutBucketInventoryConfigurationCommandInput}
@@ -167,6 +154,8 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata
167
154
  * @see {@link PutBucketInventoryConfigurationCommandOutput} for command's `response` shape.
168
155
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
169
156
  *
157
+ * @throws {@link S3ServiceException}
158
+ * <p>Base exception class for all service exceptions from S3 service.</p>
170
159
  *
171
160
  */
172
161
  export declare class PutBucketInventoryConfigurationCommand extends $Command<PutBucketInventoryConfigurationCommandInput, PutBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -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, so if
24
- * you want to retain any configuration details, they must be included in the new lifecycle
25
- * configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage
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
- * <p>
35
- * <b>Rules</b>
36
- * </p>
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
59
- * Lifecycle Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration Elements</a>.</p>
60
- * <p>
61
- * <b>Permissions</b>
62
- * </p>
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 Your Amazon S3
90
- * Resources</a>.</p>
91
- * <p>The following are related to <code>PutBucketLifecycleConfiguration</code>:</p>
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>
@@ -175,6 +177,8 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata
175
177
  * };
176
178
  * const command = new PutBucketLifecycleConfigurationCommand(input);
177
179
  * const response = await client.send(command);
180
+ * // {};
181
+ *
178
182
  * ```
179
183
  *
180
184
  * @param PutBucketLifecycleConfigurationCommandInput - {@link PutBucketLifecycleConfigurationCommandInput}
@@ -183,6 +187,8 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata
183
187
  * @see {@link PutBucketLifecycleConfigurationCommandOutput} for command's `response` shape.
184
188
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
185
189
  *
190
+ * @throws {@link S3ServiceException}
191
+ * <p>Base exception class for all service exceptions from S3 service.</p>
186
192
  *
187
193
  * @example Put bucket lifecycle
188
194
  * ```javascript
@@ -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 the
24
- * source bucket. To set the logging status of a bucket, you must be the bucket owner.</p>
25
- * <p>The bucket owner is automatically granted FULL_CONTROL to all logs. You use the <code>Grantee</code> request element to grant access to other people. The
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
- * setting for S3 Object Ownership, you can't use the <code>Grantee</code> request element
31
- * to grant access to others. Permissions can only be granted using policies. For more information, see <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
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
- * <p>
35
- * <b>Grantee Values</b>
36
- * </p>
37
- * <p>You can specify the person (grantee) to whom you're assigning access rights (using
38
- * request elements) in the following ways:</p>
39
- * <ul>
40
- * <li>
41
- * <p>By the person's ID:</p>
42
- * <p>
43
- * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
44
- * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
45
- * </Grantee></code>
46
- * </p>
47
- * <p>DisplayName is optional and ignored in the request.</p>
48
- * </li>
49
- * <li>
50
- * <p>By Email address:</p>
51
- * <p>
52
- * <code> <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
53
- * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee></code>
54
- * </p>
55
- * <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object
56
- * acl request, appears as the CanonicalUser.</p>
57
- * </li>
58
- * <li>
59
- * <p>By URI:</p>
60
- * <p>
61
- * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
62
- * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code>
63
- * </p>
64
- * </li>
65
- * </ul>
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 <i>Amazon S3 User Guide</i>. </p>
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>
@@ -127,6 +133,8 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
127
133
  * };
128
134
  * const command = new PutBucketLoggingCommand(input);
129
135
  * const response = await client.send(command);
136
+ * // {};
137
+ *
130
138
  * ```
131
139
  *
132
140
  * @param PutBucketLoggingCommandInput - {@link PutBucketLoggingCommandInput}
@@ -135,6 +143,8 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {
135
143
  * @see {@link PutBucketLoggingCommandOutput} for command's `response` shape.
136
144
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
137
145
  *
146
+ * @throws {@link S3ServiceException}
147
+ * <p>Base exception class for all service exceptions from S3 service.</p>
138
148
  *
139
149
  * @example Set logging configuration for a bucket
140
150
  * ```javascript
@@ -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 Access Permissions to Your Amazon S3
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 Metrics with Amazon
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>
@@ -100,6 +100,8 @@ export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBe
100
100
  * };
101
101
  * const command = new PutBucketMetricsConfigurationCommand(input);
102
102
  * const response = await client.send(command);
103
+ * // {};
104
+ *
103
105
  * ```
104
106
  *
105
107
  * @param PutBucketMetricsConfigurationCommandInput - {@link PutBucketMetricsConfigurationCommandInput}
@@ -108,6 +110,8 @@ export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBe
108
110
  * @see {@link PutBucketMetricsConfigurationCommandOutput} for command's `response` shape.
109
111
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
110
112
  *
113
+ * @throws {@link S3ServiceException}
114
+ * <p>Base exception class for all service exceptions from S3 service.</p>
111
115
  *
112
116
  */
113
117
  export declare class PutBucketMetricsConfigurationCommand extends $Command<PutBucketMetricsConfigurationCommandInput, PutBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -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
- * Notifications</a>.</p>
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
- * you include in the request body.</p>
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 create per bucket, see
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 General Reference</i>.</p>
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
- * the configuration to your bucket.</p>
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
@@ -147,6 +144,8 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
147
144
  * };
148
145
  * const command = new PutBucketNotificationConfigurationCommand(input);
149
146
  * const response = await client.send(command);
147
+ * // {};
148
+ *
150
149
  * ```
151
150
  *
152
151
  * @param PutBucketNotificationConfigurationCommandInput - {@link PutBucketNotificationConfigurationCommandInput}
@@ -155,6 +154,8 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
155
154
  * @see {@link PutBucketNotificationConfigurationCommandOutput} for command's `response` shape.
156
155
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
157
156
  *
157
+ * @throws {@link S3ServiceException}
158
+ * <p>Base exception class for all service exceptions from S3 service.</p>
158
159
  *
159
160
  * @example Set notification configuration for a bucket
160
161
  * ```javascript
@@ -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 policy</a>. </p>
25
- * <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>
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>
@@ -56,6 +58,8 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare
56
58
  * };
57
59
  * const command = new PutBucketOwnershipControlsCommand(input);
58
60
  * const response = await client.send(command);
61
+ * // {};
62
+ *
59
63
  * ```
60
64
  *
61
65
  * @param PutBucketOwnershipControlsCommandInput - {@link PutBucketOwnershipControlsCommandInput}
@@ -64,6 +68,8 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare
64
68
  * @see {@link PutBucketOwnershipControlsCommandOutput} for command's `response` shape.
65
69
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
66
70
  *
71
+ * @throws {@link S3ServiceException}
72
+ * <p>Base exception class for all service exceptions from S3 service.</p>
67
73
  *
68
74
  */
69
75
  export declare class PutBucketOwnershipControlsCommand extends $Command<PutBucketOwnershipControlsCommandInput, PutBucketOwnershipControlsCommandOutput, S3ClientResolvedConfig> {
@@ -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> As a security precaution, the root user of the Amazon Web Services account that owns a bucket can
32
- * always use this operation, even if the policy explicitly denies the root user the
33
- * ability to perform this action. </p>
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 examples</a>.</p>
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>
@@ -62,6 +66,8 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
62
66
  * };
63
67
  * const command = new PutBucketPolicyCommand(input);
64
68
  * const response = await client.send(command);
69
+ * // {};
70
+ *
65
71
  * ```
66
72
  *
67
73
  * @param PutBucketPolicyCommandInput - {@link PutBucketPolicyCommandInput}
@@ -70,6 +76,8 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
70
76
  * @see {@link PutBucketPolicyCommandOutput} for command's `response` shape.
71
77
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
72
78
  *
79
+ * @throws {@link S3ServiceException}
80
+ * <p>Base exception class for all service exceptions from S3 service.</p>
73
81
  *
74
82
  * @example Set bucket policy
75
83
  * ```javascript