@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
@@ -24,10 +24,10 @@ export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMet
24
24
  * <p> To use this operation, you must have permissions to perform the
25
25
  * <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
26
26
  * default. The bucket owner can grant this permission to others. For more information about
27
- * 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
28
- * Resources</a>.</p>
29
- * <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
30
- * CloudWatch</a>.</p>
27
+ * 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
28
+ * Access Permissions to Your Amazon S3 Resources</a>.</p>
29
+ * <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
30
+ * Metrics with Amazon CloudWatch</a>.</p>
31
31
  * <p>The following operations are related to
32
32
  * <code>GetBucketMetricsConfiguration</code>:</p>
33
33
  * <ul>
@@ -48,8 +48,7 @@ export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMet
48
48
  * </li>
49
49
  * <li>
50
50
  * <p>
51
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
52
- * CloudWatch</a>
51
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>
53
52
  * </p>
54
53
  * </li>
55
54
  * </ul>
@@ -66,6 +65,30 @@ export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMet
66
65
  * };
67
66
  * const command = new GetBucketMetricsConfigurationCommand(input);
68
67
  * const response = await client.send(command);
68
+ * // { // GetBucketMetricsConfigurationOutput
69
+ * // MetricsConfiguration: { // MetricsConfiguration
70
+ * // Id: "STRING_VALUE", // required
71
+ * // Filter: { // MetricsFilter Union: only one key present
72
+ * // Prefix: "STRING_VALUE",
73
+ * // Tag: { // Tag
74
+ * // Key: "STRING_VALUE", // required
75
+ * // Value: "STRING_VALUE", // required
76
+ * // },
77
+ * // AccessPointArn: "STRING_VALUE",
78
+ * // And: { // MetricsAndOperator
79
+ * // Prefix: "STRING_VALUE",
80
+ * // Tags: [ // TagSet
81
+ * // {
82
+ * // Key: "STRING_VALUE", // required
83
+ * // Value: "STRING_VALUE", // required
84
+ * // },
85
+ * // ],
86
+ * // AccessPointArn: "STRING_VALUE",
87
+ * // },
88
+ * // },
89
+ * // },
90
+ * // };
91
+ *
69
92
  * ```
70
93
  *
71
94
  * @param GetBucketMetricsConfigurationCommandInput - {@link GetBucketMetricsConfigurationCommandInput}
@@ -74,6 +97,8 @@ export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMet
74
97
  * @see {@link GetBucketMetricsConfigurationCommandOutput} for command's `response` shape.
75
98
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
76
99
  *
100
+ * @throws {@link S3ServiceException}
101
+ * <p>Base exception class for all service exceptions from S3 service.</p>
77
102
  *
78
103
  */
79
104
  export declare class GetBucketMetricsConfigurationCommand extends $Command<GetBucketMetricsConfigurationCommandInput, GetBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -26,9 +26,14 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific
26
26
  * bucket. However, the bucket owner can use a bucket policy to grant permission to other
27
27
  * users to read this configuration with the <code>s3:GetBucketNotification</code>
28
28
  * permission.</p>
29
+ * <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
30
+ * <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
31
+ * If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
32
+ * For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
33
+ * Error Codes</a>.</p>
29
34
  * <p>For more information about setting and reading the notification configuration on a
30
- * bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of
31
- * Bucket Events</a>. For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>.</p>
35
+ * bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of Bucket Events</a>. For more information about bucket
36
+ * policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>.</p>
32
37
  * <p>The following action is related to <code>GetBucketNotification</code>:</p>
33
38
  * <ul>
34
39
  * <li>
@@ -49,6 +54,67 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific
49
54
  * };
50
55
  * const command = new GetBucketNotificationConfigurationCommand(input);
51
56
  * const response = await client.send(command);
57
+ * // { // NotificationConfiguration
58
+ * // TopicConfigurations: [ // TopicConfigurationList
59
+ * // { // TopicConfiguration
60
+ * // Id: "STRING_VALUE",
61
+ * // TopicArn: "STRING_VALUE", // required
62
+ * // Events: [ // EventList // required
63
+ * // "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
64
+ * // ],
65
+ * // Filter: { // NotificationConfigurationFilter
66
+ * // Key: { // S3KeyFilter
67
+ * // FilterRules: [ // FilterRuleList
68
+ * // { // FilterRule
69
+ * // Name: "prefix" || "suffix",
70
+ * // Value: "STRING_VALUE",
71
+ * // },
72
+ * // ],
73
+ * // },
74
+ * // },
75
+ * // },
76
+ * // ],
77
+ * // QueueConfigurations: [ // QueueConfigurationList
78
+ * // { // QueueConfiguration
79
+ * // Id: "STRING_VALUE",
80
+ * // QueueArn: "STRING_VALUE", // required
81
+ * // Events: [ // required
82
+ * // "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
83
+ * // ],
84
+ * // Filter: {
85
+ * // Key: {
86
+ * // FilterRules: [
87
+ * // {
88
+ * // Name: "prefix" || "suffix",
89
+ * // Value: "STRING_VALUE",
90
+ * // },
91
+ * // ],
92
+ * // },
93
+ * // },
94
+ * // },
95
+ * // ],
96
+ * // LambdaFunctionConfigurations: [ // LambdaFunctionConfigurationList
97
+ * // { // LambdaFunctionConfiguration
98
+ * // Id: "STRING_VALUE",
99
+ * // LambdaFunctionArn: "STRING_VALUE", // required
100
+ * // Events: [ // required
101
+ * // "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
102
+ * // ],
103
+ * // Filter: {
104
+ * // Key: {
105
+ * // FilterRules: [
106
+ * // {
107
+ * // Name: "prefix" || "suffix",
108
+ * // Value: "STRING_VALUE",
109
+ * // },
110
+ * // ],
111
+ * // },
112
+ * // },
113
+ * // },
114
+ * // ],
115
+ * // EventBridgeConfiguration: {},
116
+ * // };
117
+ *
52
118
  * ```
53
119
  *
54
120
  * @param GetBucketNotificationConfigurationCommandInput - {@link GetBucketNotificationConfigurationCommandInput}
@@ -57,6 +123,8 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific
57
123
  * @see {@link GetBucketNotificationConfigurationCommandOutput} for command's `response` shape.
58
124
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
59
125
  *
126
+ * @throws {@link S3ServiceException}
127
+ * <p>Base exception class for all service exceptions from S3 service.</p>
60
128
  *
61
129
  */
62
130
  export declare class GetBucketNotificationConfigurationCommand extends $Command<GetBucketNotificationConfigurationCommandInput, GetBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig> {
@@ -21,9 +21,10 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners
21
21
  * @public
22
22
  * <p>Retrieves <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
23
23
  * must have the <code>s3:GetBucketOwnershipControls</code> permission. For more information
24
- * about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying
25
- * permissions in a policy</a>. </p>
26
- * <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Using Object Ownership</a>. </p>
24
+ * about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/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/userguide/about-object-ownership.html">Using Object
27
+ * Ownership</a>. </p>
27
28
  * <p>The following operations are related to <code>GetBucketOwnershipControls</code>:</p>
28
29
  * <ul>
29
30
  * <li>
@@ -49,6 +50,16 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners
49
50
  * };
50
51
  * const command = new GetBucketOwnershipControlsCommand(input);
51
52
  * const response = await client.send(command);
53
+ * // { // GetBucketOwnershipControlsOutput
54
+ * // OwnershipControls: { // OwnershipControls
55
+ * // Rules: [ // OwnershipControlsRules // required
56
+ * // { // OwnershipControlsRule
57
+ * // ObjectOwnership: "BucketOwnerPreferred" || "ObjectWriter" || "BucketOwnerEnforced", // required
58
+ * // },
59
+ * // ],
60
+ * // },
61
+ * // };
62
+ *
52
63
  * ```
53
64
  *
54
65
  * @param GetBucketOwnershipControlsCommandInput - {@link GetBucketOwnershipControlsCommandInput}
@@ -57,6 +68,8 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners
57
68
  * @see {@link GetBucketOwnershipControlsCommandOutput} for command's `response` shape.
58
69
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
59
70
  *
71
+ * @throws {@link S3ServiceException}
72
+ * <p>Base exception class for all service exceptions from S3 service.</p>
60
73
  *
61
74
  */
62
75
  export declare class GetBucketOwnershipControlsCommand extends $Command<GetBucketOwnershipControlsCommandInput, GetBucketOwnershipControlsCommandOutput, S3ClientResolvedConfig> {
@@ -28,10 +28,18 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
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>
38
+ * <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
39
+ * <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
40
+ * If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
41
+ * For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
42
+ * Error Codes</a>.</p>
35
43
  * <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
36
44
  * Policies</a>.</p>
37
45
  * <p>The following action is related to <code>GetBucketPolicy</code>:</p>
@@ -54,6 +62,10 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
54
62
  * };
55
63
  * const command = new GetBucketPolicyCommand(input);
56
64
  * const response = await client.send(command);
65
+ * // { // GetBucketPolicyOutput
66
+ * // Policy: "STRING_VALUE",
67
+ * // };
68
+ *
57
69
  * ```
58
70
  *
59
71
  * @param GetBucketPolicyCommandInput - {@link GetBucketPolicyCommandInput}
@@ -62,6 +74,8 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
62
74
  * @see {@link GetBucketPolicyCommandOutput} for command's `response` shape.
63
75
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
64
76
  *
77
+ * @throws {@link S3ServiceException}
78
+ * <p>Base exception class for all service exceptions from S3 service.</p>
65
79
  *
66
80
  * @example To get bucket policy
67
81
  * ```javascript
@@ -22,7 +22,7 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu
22
22
  * <p>Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
23
23
  * In order to use this operation, you must have the <code>s3:GetBucketPolicyStatus</code>
24
24
  * permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
25
- * Policy</a>.</p>
25
+ * Policy</a>.</p>
26
26
  * <p> For more information about when Amazon S3 considers a bucket public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>. </p>
27
27
  * <p>The following operations are related to <code>GetBucketPolicyStatus</code>:</p>
28
28
  * <ul>
@@ -60,6 +60,12 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu
60
60
  * };
61
61
  * const command = new GetBucketPolicyStatusCommand(input);
62
62
  * const response = await client.send(command);
63
+ * // { // GetBucketPolicyStatusOutput
64
+ * // PolicyStatus: { // PolicyStatus
65
+ * // IsPublic: true || false,
66
+ * // },
67
+ * // };
68
+ *
63
69
  * ```
64
70
  *
65
71
  * @param GetBucketPolicyStatusCommandInput - {@link GetBucketPolicyStatusCommandInput}
@@ -68,6 +74,8 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu
68
74
  * @see {@link GetBucketPolicyStatusCommandOutput} for command's `response` shape.
69
75
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
70
76
  *
77
+ * @throws {@link S3ServiceException}
78
+ * <p>Base exception class for all service exceptions from S3 service.</p>
71
79
  *
72
80
  */
73
81
  export declare class GetBucketPolicyStatusCommand extends $Command<GetBucketPolicyStatusCommandInput, GetBucketPolicyStatusCommandOutput, S3ClientResolvedConfig> {
@@ -61,6 +61,73 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
61
61
  * };
62
62
  * const command = new GetBucketReplicationCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // GetBucketReplicationOutput
65
+ * // ReplicationConfiguration: { // ReplicationConfiguration
66
+ * // Role: "STRING_VALUE", // required
67
+ * // Rules: [ // ReplicationRules // required
68
+ * // { // ReplicationRule
69
+ * // ID: "STRING_VALUE",
70
+ * // Priority: Number("int"),
71
+ * // Prefix: "STRING_VALUE",
72
+ * // Filter: { // ReplicationRuleFilter Union: only one key present
73
+ * // Prefix: "STRING_VALUE",
74
+ * // Tag: { // Tag
75
+ * // Key: "STRING_VALUE", // required
76
+ * // Value: "STRING_VALUE", // required
77
+ * // },
78
+ * // And: { // ReplicationRuleAndOperator
79
+ * // Prefix: "STRING_VALUE",
80
+ * // Tags: [ // TagSet
81
+ * // {
82
+ * // Key: "STRING_VALUE", // required
83
+ * // Value: "STRING_VALUE", // required
84
+ * // },
85
+ * // ],
86
+ * // },
87
+ * // },
88
+ * // Status: "Enabled" || "Disabled", // required
89
+ * // SourceSelectionCriteria: { // SourceSelectionCriteria
90
+ * // SseKmsEncryptedObjects: { // SseKmsEncryptedObjects
91
+ * // Status: "Enabled" || "Disabled", // required
92
+ * // },
93
+ * // ReplicaModifications: { // ReplicaModifications
94
+ * // Status: "Enabled" || "Disabled", // required
95
+ * // },
96
+ * // },
97
+ * // ExistingObjectReplication: { // ExistingObjectReplication
98
+ * // Status: "Enabled" || "Disabled", // required
99
+ * // },
100
+ * // Destination: { // Destination
101
+ * // Bucket: "STRING_VALUE", // required
102
+ * // Account: "STRING_VALUE",
103
+ * // StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
104
+ * // AccessControlTranslation: { // AccessControlTranslation
105
+ * // Owner: "Destination", // required
106
+ * // },
107
+ * // EncryptionConfiguration: { // EncryptionConfiguration
108
+ * // ReplicaKmsKeyID: "STRING_VALUE",
109
+ * // },
110
+ * // ReplicationTime: { // ReplicationTime
111
+ * // Status: "Enabled" || "Disabled", // required
112
+ * // Time: { // ReplicationTimeValue
113
+ * // Minutes: Number("int"),
114
+ * // },
115
+ * // },
116
+ * // Metrics: { // Metrics
117
+ * // Status: "Enabled" || "Disabled", // required
118
+ * // EventThreshold: {
119
+ * // Minutes: Number("int"),
120
+ * // },
121
+ * // },
122
+ * // },
123
+ * // DeleteMarkerReplication: { // DeleteMarkerReplication
124
+ * // Status: "Enabled" || "Disabled",
125
+ * // },
126
+ * // },
127
+ * // ],
128
+ * // },
129
+ * // };
130
+ *
64
131
  * ```
65
132
  *
66
133
  * @param GetBucketReplicationCommandInput - {@link GetBucketReplicationCommandInput}
@@ -69,6 +136,8 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
69
136
  * @see {@link GetBucketReplicationCommandOutput} for command's `response` shape.
70
137
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
71
138
  *
139
+ * @throws {@link S3ServiceException}
140
+ * <p>Base exception class for all service exceptions from S3 service.</p>
72
141
  *
73
142
  * @example To get replication configuration set on a bucket
74
143
  * ```javascript
@@ -20,7 +20,8 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
20
20
  /**
21
21
  * @public
22
22
  * <p>Returns the request payment configuration of a bucket. To use this version of the
23
- * operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>.</p>
23
+ * operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
24
+ * Buckets</a>.</p>
24
25
  * <p>The following operations are related to <code>GetBucketRequestPayment</code>:</p>
25
26
  * <ul>
26
27
  * <li>
@@ -41,6 +42,10 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
41
42
  * };
42
43
  * const command = new GetBucketRequestPaymentCommand(input);
43
44
  * const response = await client.send(command);
45
+ * // { // GetBucketRequestPaymentOutput
46
+ * // Payer: "Requester" || "BucketOwner",
47
+ * // };
48
+ *
44
49
  * ```
45
50
  *
46
51
  * @param GetBucketRequestPaymentCommandInput - {@link GetBucketRequestPaymentCommandInput}
@@ -49,6 +54,8 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa
49
54
  * @see {@link GetBucketRequestPaymentCommandOutput} for command's `response` shape.
50
55
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
51
56
  *
57
+ * @throws {@link S3ServiceException}
58
+ * <p>Base exception class for all service exceptions from S3 service.</p>
52
59
  *
53
60
  * @example To get bucket versioning configuration
54
61
  * ```javascript
@@ -61,6 +61,15 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
61
61
  * };
62
62
  * const command = new GetBucketTaggingCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // GetBucketTaggingOutput
65
+ * // TagSet: [ // TagSet // required
66
+ * // { // Tag
67
+ * // Key: "STRING_VALUE", // required
68
+ * // Value: "STRING_VALUE", // required
69
+ * // },
70
+ * // ],
71
+ * // };
72
+ *
64
73
  * ```
65
74
  *
66
75
  * @param GetBucketTaggingCommandInput - {@link GetBucketTaggingCommandInput}
@@ -69,6 +78,8 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
69
78
  * @see {@link GetBucketTaggingCommandOutput} for command's `response` shape.
70
79
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
71
80
  *
81
+ * @throws {@link S3ServiceException}
82
+ * <p>Base exception class for all service exceptions from S3 service.</p>
72
83
  *
73
84
  * @example To get tag set associated with a bucket
74
85
  * ```javascript
@@ -54,6 +54,11 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
54
54
  * };
55
55
  * const command = new GetBucketVersioningCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // GetBucketVersioningOutput
58
+ * // Status: "Enabled" || "Suspended",
59
+ * // MFADelete: "Enabled" || "Disabled",
60
+ * // };
61
+ *
57
62
  * ```
58
63
  *
59
64
  * @param GetBucketVersioningCommandInput - {@link GetBucketVersioningCommandInput}
@@ -62,6 +67,8 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
62
67
  * @see {@link GetBucketVersioningCommandOutput} for command's `response` shape.
63
68
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
64
69
  *
70
+ * @throws {@link S3ServiceException}
71
+ * <p>Base exception class for all service exceptions from S3 service.</p>
65
72
  *
66
73
  * @example To get bucket versioning configuration
67
74
  * ```javascript
@@ -21,13 +21,12 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
21
21
  * @public
22
22
  * <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can
23
23
  * configure a bucket as website by adding a website configuration. For more information about
24
- * hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on
25
- * Amazon S3</a>. </p>
24
+ * hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p>
26
25
  * <p>This GET action requires the <code>S3:GetBucketWebsite</code> permission. By default,
27
26
  * only the bucket owner can read the bucket website configuration. However, bucket owners can
28
27
  * allow other users to read the website configuration by writing a bucket policy granting
29
28
  * them the <code>S3:GetBucketWebsite</code> permission.</p>
30
- * <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p>
29
+ * <p>The following operations are related to <code>GetBucketWebsite</code>:</p>
31
30
  * <ul>
32
31
  * <li>
33
32
  * <p>
@@ -52,6 +51,34 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
52
51
  * };
53
52
  * const command = new GetBucketWebsiteCommand(input);
54
53
  * const response = await client.send(command);
54
+ * // { // GetBucketWebsiteOutput
55
+ * // RedirectAllRequestsTo: { // RedirectAllRequestsTo
56
+ * // HostName: "STRING_VALUE", // required
57
+ * // Protocol: "http" || "https",
58
+ * // },
59
+ * // IndexDocument: { // IndexDocument
60
+ * // Suffix: "STRING_VALUE", // required
61
+ * // },
62
+ * // ErrorDocument: { // ErrorDocument
63
+ * // Key: "STRING_VALUE", // required
64
+ * // },
65
+ * // RoutingRules: [ // RoutingRules
66
+ * // { // RoutingRule
67
+ * // Condition: { // Condition
68
+ * // HttpErrorCodeReturnedEquals: "STRING_VALUE",
69
+ * // KeyPrefixEquals: "STRING_VALUE",
70
+ * // },
71
+ * // Redirect: { // Redirect
72
+ * // HostName: "STRING_VALUE",
73
+ * // HttpRedirectCode: "STRING_VALUE",
74
+ * // Protocol: "http" || "https",
75
+ * // ReplaceKeyPrefixWith: "STRING_VALUE",
76
+ * // ReplaceKeyWith: "STRING_VALUE",
77
+ * // },
78
+ * // },
79
+ * // ],
80
+ * // };
81
+ *
55
82
  * ```
56
83
  *
57
84
  * @param GetBucketWebsiteCommandInput - {@link GetBucketWebsiteCommandInput}
@@ -60,6 +87,8 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
60
87
  * @see {@link GetBucketWebsiteCommandOutput} for command's `response` shape.
61
88
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
62
89
  *
90
+ * @throws {@link S3ServiceException}
91
+ * <p>Base exception class for all service exceptions from S3 service.</p>
63
92
  *
64
93
  * @example To get bucket website configuration
65
94
  * ```javascript
@@ -25,17 +25,15 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
25
25
  * User Guide</i>
26
26
  * </p>
27
27
  * <p>This action is not supported by Amazon S3 on Outposts.</p>
28
- * <p>
29
- * <b>Versioning</b>
30
- * </p>
31
28
  * <p>By default, GET returns ACL information about the current version of an object. To
32
29
  * return ACL information about a different version, use the versionId subresource.</p>
33
30
  * <note>
34
31
  * <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
35
- * requests to read ACLs are still supported and return the <code>bucket-owner-full-control</code>
36
- * ACL with the owner being the account that created the bucket. For more information, see
37
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">
38
- * Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
32
+ * requests to read ACLs are still supported and return the
33
+ * <code>bucket-owner-full-control</code> ACL with the owner being the account that
34
+ * created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object
35
+ * ownership and disabling ACLs</a> in the
36
+ * <i>Amazon S3 User Guide</i>.</p>
39
37
  * </note>
40
38
  * <p>The following operations are related to <code>GetObjectAcl</code>:</p>
41
39
  * <ul>
@@ -75,6 +73,26 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
75
73
  * };
76
74
  * const command = new GetObjectAclCommand(input);
77
75
  * const response = await client.send(command);
76
+ * // { // GetObjectAclOutput
77
+ * // Owner: { // Owner
78
+ * // DisplayName: "STRING_VALUE",
79
+ * // ID: "STRING_VALUE",
80
+ * // },
81
+ * // Grants: [ // Grants
82
+ * // { // Grant
83
+ * // Grantee: { // Grantee
84
+ * // DisplayName: "STRING_VALUE",
85
+ * // EmailAddress: "STRING_VALUE",
86
+ * // ID: "STRING_VALUE",
87
+ * // URI: "STRING_VALUE",
88
+ * // Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
89
+ * // },
90
+ * // Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP",
91
+ * // },
92
+ * // ],
93
+ * // RequestCharged: "requester",
94
+ * // };
95
+ *
78
96
  * ```
79
97
  *
80
98
  * @param GetObjectAclCommandInput - {@link GetObjectAclCommandInput}
@@ -86,6 +104,8 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
86
104
  * @throws {@link NoSuchKey} (client fault)
87
105
  * <p>The specified key does not exist.</p>
88
106
  *
107
+ * @throws {@link S3ServiceException}
108
+ * <p>Base exception class for all service exceptions from S3 service.</p>
89
109
  *
90
110
  * @example To retrieve object ACL
91
111
  * ```javascript