@aws-sdk/client-s3 3.844.0 → 3.845.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/index.js +594 -121
  3. package/dist-es/S3.js +10 -0
  4. package/dist-es/commands/CreateBucketMetadataConfigurationCommand.js +31 -0
  5. package/dist-es/commands/DeleteBucketMetadataConfigurationCommand.js +26 -0
  6. package/dist-es/commands/GetBucketMetadataConfigurationCommand.js +28 -0
  7. package/dist-es/commands/ListPartsCommand.js +1 -1
  8. package/dist-es/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.js +31 -0
  9. package/dist-es/commands/UpdateBucketMetadataJournalTableConfigurationCommand.js +31 -0
  10. package/dist-es/commands/index.js +5 -0
  11. package/dist-es/models/models_0.js +16 -24
  12. package/dist-es/models/models_1.js +24 -0
  13. package/dist-es/protocols/Aws_restXml.js +325 -3
  14. package/dist-types/S3.d.ts +35 -0
  15. package/dist-types/S3Client.d.ts +7 -2
  16. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +17 -22
  17. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +46 -57
  18. package/dist-types/commands/CopyObjectCommand.d.ts +95 -106
  19. package/dist-types/commands/CreateBucketCommand.d.ts +70 -82
  20. package/dist-types/commands/CreateBucketMetadataConfigurationCommand.d.ts +182 -0
  21. package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +25 -12
  22. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +88 -113
  23. package/dist-types/commands/CreateSessionCommand.d.ts +45 -50
  24. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +7 -9
  25. package/dist-types/commands/DeleteBucketCommand.d.ts +10 -12
  26. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -5
  27. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +16 -18
  28. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -6
  29. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +23 -28
  30. package/dist-types/commands/DeleteBucketMetadataConfigurationCommand.d.ts +114 -0
  31. package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +26 -8
  32. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -12
  33. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +5 -6
  34. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +20 -23
  35. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +5 -7
  36. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +2 -3
  37. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +9 -10
  38. package/dist-types/commands/DeleteObjectCommand.d.ts +37 -23
  39. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +7 -7
  40. package/dist-types/commands/DeleteObjectsCommand.d.ts +37 -44
  41. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -6
  42. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +14 -17
  43. package/dist-types/commands/GetBucketAclCommand.d.ts +9 -11
  44. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +8 -11
  45. package/dist-types/commands/GetBucketCorsCommand.d.ts +4 -6
  46. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -19
  47. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +6 -8
  48. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +28 -37
  49. package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -5
  50. package/dist-types/commands/GetBucketLoggingCommand.d.ts +2 -2
  51. package/dist-types/commands/GetBucketMetadataConfigurationCommand.d.ts +146 -0
  52. package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +25 -8
  53. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +10 -11
  54. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -8
  55. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +9 -8
  56. package/dist-types/commands/GetBucketPolicyCommand.d.ts +24 -29
  57. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +5 -6
  58. package/dist-types/commands/GetBucketReplicationCommand.d.ts +11 -12
  59. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -3
  60. package/dist-types/commands/GetBucketTaggingCommand.d.ts +2 -3
  61. package/dist-types/commands/GetBucketVersioningCommand.d.ts +3 -3
  62. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +6 -7
  63. package/dist-types/commands/GetObjectAclCommand.d.ts +9 -11
  64. package/dist-types/commands/GetObjectAttributesCommand.d.ts +55 -70
  65. package/dist-types/commands/GetObjectCommand.d.ts +66 -81
  66. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -2
  67. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +3 -3
  68. package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -2
  69. package/dist-types/commands/GetObjectTaggingCommand.d.ts +8 -10
  70. package/dist-types/commands/GetObjectTorrentCommand.d.ts +4 -5
  71. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +10 -12
  72. package/dist-types/commands/HeadBucketCommand.d.ts +33 -35
  73. package/dist-types/commands/HeadObjectCommand.d.ts +50 -62
  74. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +14 -17
  75. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +12 -15
  76. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +15 -18
  77. package/dist-types/commands/ListBucketsCommand.d.ts +10 -9
  78. package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +9 -9
  79. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +41 -49
  80. package/dist-types/commands/ListObjectVersionsCommand.d.ts +7 -9
  81. package/dist-types/commands/ListObjectsCommand.d.ts +8 -7
  82. package/dist-types/commands/ListObjectsV2Command.d.ts +28 -31
  83. package/dist-types/commands/ListPartsCommand.d.ts +21 -24
  84. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +14 -18
  85. package/dist-types/commands/PutBucketAclCommand.d.ts +51 -62
  86. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +23 -25
  87. package/dist-types/commands/PutBucketCorsCommand.d.ts +23 -27
  88. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +40 -48
  89. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +11 -12
  90. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +33 -37
  91. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +51 -60
  92. package/dist-types/commands/PutBucketLoggingCommand.d.ts +26 -33
  93. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +12 -14
  94. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +29 -35
  95. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -6
  96. package/dist-types/commands/PutBucketPolicyCommand.d.ts +24 -29
  97. package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -38
  98. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -5
  99. package/dist-types/commands/PutBucketTaggingCommand.d.ts +21 -27
  100. package/dist-types/commands/PutBucketVersioningCommand.d.ts +20 -23
  101. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +19 -18
  102. package/dist-types/commands/PutObjectAclCommand.d.ts +53 -61
  103. package/dist-types/commands/PutObjectCommand.d.ts +56 -66
  104. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -3
  105. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +10 -11
  106. package/dist-types/commands/PutObjectRetentionCommand.d.ts +4 -4
  107. package/dist-types/commands/PutObjectTaggingCommand.d.ts +18 -24
  108. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +10 -12
  109. package/dist-types/commands/RenameObjectCommand.d.ts +34 -40
  110. package/dist-types/commands/RestoreObjectCommand.d.ts +76 -85
  111. package/dist-types/commands/SelectObjectContentCommand.d.ts +50 -59
  112. package/dist-types/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +161 -0
  113. package/dist-types/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +113 -0
  114. package/dist-types/commands/UploadPartCommand.d.ts +64 -74
  115. package/dist-types/commands/UploadPartCopyCommand.d.ts +80 -96
  116. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +29 -33
  117. package/dist-types/commands/index.d.ts +5 -0
  118. package/dist-types/models/models_0.d.ts +2688 -3603
  119. package/dist-types/models/models_1.d.ts +2120 -743
  120. package/dist-types/protocols/Aws_restXml.d.ts +45 -0
  121. package/dist-types/ts3.4/S3.d.ts +109 -0
  122. package/dist-types/ts3.4/S3Client.d.ts +30 -0
  123. package/dist-types/ts3.4/commands/CreateBucketMetadataConfigurationCommand.d.ts +47 -0
  124. package/dist-types/ts3.4/commands/DeleteBucketMetadataConfigurationCommand.d.ts +47 -0
  125. package/dist-types/ts3.4/commands/GetBucketMetadataConfigurationCommand.d.ts +51 -0
  126. package/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts +1 -1
  127. package/dist-types/ts3.4/commands/ListObjectsCommand.d.ts +1 -1
  128. package/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts +1 -1
  129. package/dist-types/ts3.4/commands/ListPartsCommand.d.ts +1 -1
  130. package/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
  131. package/dist-types/ts3.4/commands/PutBucketAclCommand.d.ts +1 -1
  132. package/dist-types/ts3.4/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
  133. package/dist-types/ts3.4/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +47 -0
  134. package/dist-types/ts3.4/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +47 -0
  135. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  136. package/dist-types/ts3.4/models/models_0.d.ts +93 -206
  137. package/dist-types/ts3.4/models/models_1.d.ts +238 -0
  138. package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +60 -0
  139. package/package.json +15 -15
@@ -27,23 +27,22 @@ declare const GetBucketEncryptionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets
31
- * have a default encryption configuration that uses server-side encryption with Amazon S3 managed
32
- * keys (SSE-S3). </p>
30
+ * <p>Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a
31
+ * default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). </p>
33
32
  * <note>
34
33
  * <ul>
35
34
  * <li>
36
35
  * <p>
37
- * <b>General purpose buckets</b> - For information
38
- * about the bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default
39
- * Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
36
+ * <b>General purpose buckets</b> - For information about the bucket
37
+ * default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a> in the
38
+ * <i>Amazon S3 User Guide</i>.</p>
40
39
  * </li>
41
40
  * <li>
42
41
  * <p>
43
42
  * <b>Directory buckets</b> -
44
- * For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption
45
- * configuration in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html">Setting
46
- * default server-side encryption behavior for directory buckets</a>.</p>
43
+ * For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption configuration in
44
+ * directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html">Setting default server-side
45
+ * encryption behavior for directory buckets</a>.</p>
47
46
  * </li>
48
47
  * </ul>
49
48
  * </note>
@@ -54,19 +53,17 @@ declare const GetBucketEncryptionCommand_base: {
54
53
  * <li>
55
54
  * <p>
56
55
  * <b>General purpose bucket permissions</b> - The
57
- * <code>s3:GetEncryptionConfiguration</code> permission is required in a
58
- * policy. The bucket owner has this permission by default. The bucket owner
59
- * can grant this permission to others. For more information about permissions,
60
- * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
61
- * Permissions to Your Amazon S3 Resources</a>.</p>
56
+ * <code>s3:GetEncryptionConfiguration</code> permission is required in a policy. The bucket
57
+ * owner has this permission by default. The bucket owner can grant this permission to others.
58
+ * 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 Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your
59
+ * Amazon S3 Resources</a>.</p>
62
60
  * </li>
63
61
  * <li>
64
62
  * <p>
65
- * <b>Directory bucket permissions</b> -
66
- * To grant access to this API operation, you must have the
67
- * <code>s3express:GetEncryptionConfiguration</code> permission in
68
- * an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
69
- * For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
63
+ * <b>Directory bucket permissions</b> - To grant access to
64
+ * this API operation, you must have the <code>s3express:GetEncryptionConfiguration</code>
65
+ * permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
66
+ * For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
70
67
  * </li>
71
68
  * </ul>
72
69
  * </dd>
@@ -30,16 +30,14 @@ declare const GetBucketInventoryConfigurationCommand_base: {
30
30
  * <note>
31
31
  * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
- * <p>Returns an inventory configuration (identified by the inventory configuration ID) from
34
- * the bucket.</p>
33
+ * <p>Returns an S3 Inventory configuration (identified by the inventory configuration ID) from the
34
+ * bucket.</p>
35
35
  * <p>To use this operation, you must have permissions to perform the
36
- * <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission
37
- * by default and can grant this permission to others. For more information about permissions,
38
- * 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>
36
+ * <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission by default and
37
+ * can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
38
+ * Resources</a>.</p>
40
39
  * <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p>
41
- * <p>The following operations are related to
42
- * <code>GetBucketInventoryConfiguration</code>:</p>
40
+ * <p>The following operations are related to <code>GetBucketInventoryConfiguration</code>:</p>
43
41
  * <ul>
44
42
  * <li>
45
43
  * <p>
@@ -27,19 +27,17 @@ declare const GetBucketLifecycleConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the lifecycle configuration information set on the bucket. For information about
31
- * lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle
32
- * Management</a>.</p>
33
- * <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object
34
- * key name prefix, one or more object tags, object size, or any combination of these.
35
- * Accordingly, this section describes the latest API, which is compatible with the new
36
- * functionality. The previous version of the API supported filtering based only on an object
37
- * key name prefix, which is supported for general purpose buckets for backward compatibility.
38
- * For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>.</p>
30
+ * <p>Returns the lifecycle configuration information set on the bucket. For information about lifecycle
31
+ * configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>.</p>
32
+ * <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name
33
+ * prefix, one or more object tags, object size, or any combination of these. Accordingly, this section
34
+ * describes the latest API, which is compatible with the new functionality. The previous version of the
35
+ * API supported filtering based only on an object key name prefix, which is supported for general purpose
36
+ * buckets for backward compatibility. For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>.</p>
39
37
  * <note>
40
- * <p>Lifecyle configurations for directory buckets only support expiring objects and
41
- * cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters
42
- * are not supported.</p>
38
+ * <p>Lifecyle configurations for directory buckets only support expiring objects and cancelling
39
+ * multipart uploads. Expiring of versioned objects, transitions and tag filters are not
40
+ * supported.</p>
43
41
  * </note>
44
42
  * <dl>
45
43
  * <dt>Permissions</dt>
@@ -47,31 +45,26 @@ declare const GetBucketLifecycleConfigurationCommand_base: {
47
45
  * <ul>
48
46
  * <li>
49
47
  * <p>
50
- * <b>General purpose bucket permissions</b> - By
51
- * default, all Amazon S3 resources are private, including buckets, objects, and
52
- * related subresources (for example, lifecycle configuration and website
53
- * configuration). Only the resource owner (that is, the Amazon Web Services account that
54
- * created it) can access the resource. The resource owner can optionally grant
55
- * access permissions to others by writing an access policy. For this
56
- * operation, a user must have the <code>s3:GetLifecycleConfiguration</code>
57
- * permission.</p>
58
- * <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
59
- * Permissions to Your Amazon S3 Resources</a>.</p>
48
+ * <b>General purpose bucket permissions</b> - By default, all Amazon S3
49
+ * resources are private, including buckets, objects, and related subresources (for example,
50
+ * lifecycle configuration and website configuration). Only the resource owner (that is, the
51
+ * Amazon Web Services account that created it) can access the resource. The resource owner can optionally
52
+ * grant access permissions to others by writing an access policy. For this operation, a user
53
+ * must have the <code>s3:GetLifecycleConfiguration</code> permission.</p>
54
+ * <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
55
+ * Amazon S3 Resources</a>.</p>
60
56
  * </li>
61
57
  * </ul>
62
58
  * <ul>
63
59
  * <li>
64
60
  * <p>
65
- * <b>Directory bucket permissions</b> -
66
- * You must have the <code>s3express:GetLifecycleConfiguration</code>
67
- * permission in an IAM identity-based policy to use this operation.
68
- * Cross-account access to this API operation isn't supported. The resource
69
- * owner can optionally grant access permissions to others by creating a role
70
- * or user for them as long as they are within the same account as the owner
71
- * and resource.</p>
72
- * <p>For more information about directory bucket policies and permissions, see
73
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Authorizing Regional endpoint APIs with IAM</a> in the
74
- * <i>Amazon S3 User Guide</i>.</p>
61
+ * <b>Directory bucket permissions</b> - You must have the
62
+ * <code>s3express:GetLifecycleConfiguration</code> permission in an IAM identity-based policy
63
+ * to use this operation. Cross-account access to this API operation isn't supported. The
64
+ * resource owner can optionally grant access permissions to others by creating a role or user
65
+ * for them as long as they are within the same account as the owner and resource.</p>
66
+ * <p>For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Authorizing Regional endpoint APIs with IAM</a> in the <i>Amazon S3 User
67
+ * Guide</i>.</p>
75
68
  * <note>
76
69
  * <p>
77
70
  * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
@@ -86,9 +79,8 @@ declare const GetBucketLifecycleConfigurationCommand_base: {
86
79
  * <dt>HTTP Host header syntax</dt>
87
80
  * <dd>
88
81
  * <p>
89
- * <b>Directory buckets </b> - The HTTP Host
90
- * header syntax is
91
- * <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
82
+ * <b>Directory buckets </b> - The HTTP Host header syntax is
83
+ * <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
92
84
  * </dd>
93
85
  * </dl>
94
86
  * <p>
@@ -110,8 +102,7 @@ declare const GetBucketLifecycleConfigurationCommand_base: {
110
102
  * </ul>
111
103
  * </li>
112
104
  * </ul>
113
- * <p>The following operations are related to
114
- * <code>GetBucketLifecycleConfiguration</code>:</p>
105
+ * <p>The following operations are related to <code>GetBucketLifecycleConfiguration</code>:</p>
115
106
  * <ul>
116
107
  * <li>
117
108
  * <p>
@@ -31,17 +31,16 @@ declare const GetBucketLocationCommand_base: {
31
31
  * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
33
  * <p>Returns the Region the bucket resides in. You set the bucket's Region using the
34
- * <code>LocationConstraint</code> request parameter in a <code>CreateBucket</code>
35
- * request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>.</p>
34
+ * <code>LocationConstraint</code> request parameter in a <code>CreateBucket</code> request. For more
35
+ * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>.</p>
36
36
  * <p>When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.</p>
37
37
  * <p>When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
38
38
  * If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
39
39
  * For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
40
40
  * Error Codes</a>.</p>
41
41
  * <note>
42
- * <p>We recommend that you use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a> to return the Region
43
- * that a bucket resides in. For backward compatibility, Amazon S3 continues to support
44
- * GetBucketLocation.</p>
42
+ * <p>We recommend that you use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a> to return the Region that a bucket
43
+ * resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.</p>
45
44
  * </note>
46
45
  * <p>The following operations are related to <code>GetBucketLocation</code>:</p>
47
46
  * <ul>
@@ -37,8 +37,8 @@ declare const GetBucketLoggingCommand_base: {
37
37
  * <note>
38
38
  * <p>This operation is not supported for directory buckets.</p>
39
39
  * </note>
40
- * <p>Returns the logging status of a bucket and the permissions users have to view and modify
41
- * that status.</p>
40
+ * <p>Returns the logging status of a bucket and the permissions users have to view and modify that
41
+ * status.</p>
42
42
  * <p>The following operations are related to <code>GetBucketLogging</code>:</p>
43
43
  * <ul>
44
44
  * <li>
@@ -0,0 +1,146 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetBucketMetadataConfigurationOutput, GetBucketMetadataConfigurationRequest } from "../models/models_0";
4
+ import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetBucketMetadataConfigurationCommand}.
14
+ */
15
+ export interface GetBucketMetadataConfigurationCommandInput extends GetBucketMetadataConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetBucketMetadataConfigurationCommand}.
21
+ */
22
+ export interface GetBucketMetadataConfigurationCommandOutput extends GetBucketMetadataConfigurationOutput, __MetadataBearer {
23
+ }
24
+ declare const GetBucketMetadataConfigurationCommand_base: {
25
+ new (input: GetBucketMetadataConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketMetadataConfigurationCommandInput, GetBucketMetadataConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetBucketMetadataConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketMetadataConfigurationCommandInput, GetBucketMetadataConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves the S3 Metadata configuration for a general purpose bucket. For more information, see
31
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html">Accelerating
32
+ * data discovery with S3 Metadata</a> in the <i>Amazon S3 User Guide</i>. </p>
33
+ * <note>
34
+ * <p>You can use the V2 <code>GetBucketMetadataConfiguration</code> API operation with V1 or V2
35
+ * metadata configurations. However, if you try to use the V1
36
+ * <code>GetBucketMetadataTableConfiguration</code> API operation with V2 configurations, you
37
+ * will receive an HTTP <code>405 Method Not Allowed</code> error.</p>
38
+ * </note>
39
+ * <dl>
40
+ * <dt>Permissions</dt>
41
+ * <dd>
42
+ * <p>To use this operation, you must have the <code>s3:GetBucketMetadataTableConfiguration</code>
43
+ * permission. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up permissions for
44
+ * configuring metadata tables</a> in the <i>Amazon S3 User Guide</i>. </p>
45
+ * <note>
46
+ * <p>The IAM policy action name is the same for the V1 and V2 API operations.</p>
47
+ * </note>
48
+ * </dd>
49
+ * </dl>
50
+ * <p>The following operations are related to <code>GetBucketMetadataConfiguration</code>:</p>
51
+ * <ul>
52
+ * <li>
53
+ * <p>
54
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html">CreateBucketMetadataConfiguration</a>
55
+ * </p>
56
+ * </li>
57
+ * <li>
58
+ * <p>
59
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataConfiguration.html">DeleteBucketMetadataConfiguration</a>
60
+ * </p>
61
+ * </li>
62
+ * <li>
63
+ * <p>
64
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataInventoryTableConfiguration.html">UpdateBucketMetadataInventoryTableConfiguration</a>
65
+ * </p>
66
+ * </li>
67
+ * <li>
68
+ * <p>
69
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataJournalTableConfiguration.html">UpdateBucketMetadataJournalTableConfiguration</a>
70
+ * </p>
71
+ * </li>
72
+ * </ul>
73
+ * @example
74
+ * Use a bare-bones client and the command you need to make an API call.
75
+ * ```javascript
76
+ * import { S3Client, GetBucketMetadataConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
77
+ * // const { S3Client, GetBucketMetadataConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
78
+ * const client = new S3Client(config);
79
+ * const input = { // GetBucketMetadataConfigurationRequest
80
+ * Bucket: "STRING_VALUE", // required
81
+ * ExpectedBucketOwner: "STRING_VALUE",
82
+ * };
83
+ * const command = new GetBucketMetadataConfigurationCommand(input);
84
+ * const response = await client.send(command);
85
+ * // { // GetBucketMetadataConfigurationOutput
86
+ * // GetBucketMetadataConfigurationResult: { // GetBucketMetadataConfigurationResult
87
+ * // MetadataConfigurationResult: { // MetadataConfigurationResult
88
+ * // DestinationResult: { // DestinationResult
89
+ * // TableBucketType: "aws" || "customer",
90
+ * // TableBucketArn: "STRING_VALUE",
91
+ * // TableNamespace: "STRING_VALUE",
92
+ * // },
93
+ * // JournalTableConfigurationResult: { // JournalTableConfigurationResult
94
+ * // TableStatus: "STRING_VALUE", // required
95
+ * // Error: { // ErrorDetails
96
+ * // ErrorCode: "STRING_VALUE",
97
+ * // ErrorMessage: "STRING_VALUE",
98
+ * // },
99
+ * // TableName: "STRING_VALUE", // required
100
+ * // TableArn: "STRING_VALUE",
101
+ * // RecordExpiration: { // RecordExpiration
102
+ * // Expiration: "ENABLED" || "DISABLED", // required
103
+ * // Days: Number("int"),
104
+ * // },
105
+ * // },
106
+ * // InventoryTableConfigurationResult: { // InventoryTableConfigurationResult
107
+ * // ConfigurationState: "ENABLED" || "DISABLED", // required
108
+ * // TableStatus: "STRING_VALUE",
109
+ * // Error: {
110
+ * // ErrorCode: "STRING_VALUE",
111
+ * // ErrorMessage: "STRING_VALUE",
112
+ * // },
113
+ * // TableName: "STRING_VALUE",
114
+ * // TableArn: "STRING_VALUE",
115
+ * // },
116
+ * // },
117
+ * // },
118
+ * // };
119
+ *
120
+ * ```
121
+ *
122
+ * @param GetBucketMetadataConfigurationCommandInput - {@link GetBucketMetadataConfigurationCommandInput}
123
+ * @returns {@link GetBucketMetadataConfigurationCommandOutput}
124
+ * @see {@link GetBucketMetadataConfigurationCommandInput} for command's `input` shape.
125
+ * @see {@link GetBucketMetadataConfigurationCommandOutput} for command's `response` shape.
126
+ * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
127
+ *
128
+ * @throws {@link S3ServiceException}
129
+ * <p>Base exception class for all service exceptions from S3 service.</p>
130
+ *
131
+ *
132
+ * @public
133
+ */
134
+ export declare class GetBucketMetadataConfigurationCommand extends GetBucketMetadataConfigurationCommand_base {
135
+ /** @internal type navigation helper, not in runtime. */
136
+ protected static __types: {
137
+ api: {
138
+ input: GetBucketMetadataConfigurationRequest;
139
+ output: GetBucketMetadataConfigurationOutput;
140
+ };
141
+ sdk: {
142
+ input: GetBucketMetadataConfigurationCommandInput;
143
+ output: GetBucketMetadataConfigurationCommandOutput;
144
+ };
145
+ };
146
+ }
@@ -27,17 +27,34 @@ declare const GetBucketMetadataTableConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Retrieves the metadata table configuration for a general purpose bucket. For more
32
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html">Accelerating data
33
- * discovery with S3 Metadata</a> in the <i>Amazon S3 User Guide</i>. </p>
30
+ * <important>
31
+ * <p>
32
+ * We recommend that you retrieve your S3 Metadata configurations by using the V2
33
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html">GetBucketMetadataTableConfiguration</a> API operation. We no longer recommend using the V1
34
+ * <code>GetBucketMetadataTableConfiguration</code> API operation.
35
+ * </p>
36
+ * <p>If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete
37
+ * and re-create your configuration by using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html">CreateBucketMetadataConfiguration</a> so that you can expire journal table records and create
38
+ * a live inventory table.</p>
39
+ * </important>
40
+ * <p> Retrieves the V1 S3 Metadata configuration for a general purpose bucket. For more information, see
41
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html">Accelerating
42
+ * data discovery with S3 Metadata</a> in the <i>Amazon S3 User Guide</i>. </p>
43
+ * <note>
44
+ * <p>You can use the V2 <code>GetBucketMetadataConfiguration</code> API operation with V1 or V2
45
+ * metadata table configurations. However, if you try to use the V1
46
+ * <code>GetBucketMetadataTableConfiguration</code> API operation with V2 configurations, you
47
+ * will receive an HTTP <code>405 Method Not Allowed</code> error.</p>
48
+ * <p>Make sure that you update your processes to use the new V2 API operations
49
+ * (<code>CreateBucketMetadataConfiguration</code>, <code>GetBucketMetadataConfiguration</code>, and
50
+ * <code>DeleteBucketMetadataConfiguration</code>) instead of the V1 API operations. </p>
51
+ * </note>
34
52
  * <dl>
35
53
  * <dt>Permissions</dt>
36
54
  * <dd>
37
- * <p>To use this operation, you must have the <code>s3:GetBucketMetadataTableConfiguration</code> permission. For more
38
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up
39
- * permissions for configuring metadata tables</a> in the
40
- * <i>Amazon S3 User Guide</i>. </p>
55
+ * <p>To use this operation, you must have the <code>s3:GetBucketMetadataTableConfiguration</code>
56
+ * permission. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up permissions for
57
+ * configuring metadata tables</a> in the <i>Amazon S3 User Guide</i>. </p>
41
58
  * </dd>
42
59
  * </dl>
43
60
  * <p>The following operations are related to <code>GetBucketMetadataTableConfiguration</code>:</p>
@@ -30,17 +30,15 @@ declare const GetBucketMetricsConfigurationCommand_base: {
30
30
  * <note>
31
31
  * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
- * <p>Gets a metrics configuration (specified by the metrics configuration ID) from the
34
- * bucket. Note that this doesn't include the daily storage metrics.</p>
33
+ * <p>Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that
34
+ * this doesn't include the daily storage metrics.</p>
35
35
  * <p> To use this operation, you must have permissions to perform the
36
- * <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
37
- * default. The bucket owner can grant this permission to others. For more information about
38
- * 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
- * <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
41
- * Metrics with Amazon CloudWatch</a>.</p>
42
- * <p>The following operations are related to
43
- * <code>GetBucketMetricsConfiguration</code>:</p>
36
+ * <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by default. The
37
+ * bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
38
+ * Resources</a>.</p>
39
+ * <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
40
+ * CloudWatch</a>.</p>
41
+ * <p>The following operations are related to <code>GetBucketMetricsConfiguration</code>:</p>
44
42
  * <ul>
45
43
  * <li>
46
44
  * <p>
@@ -59,7 +57,8 @@ declare const GetBucketMetricsConfigurationCommand_base: {
59
57
  * </li>
60
58
  * <li>
61
59
  * <p>
62
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>
60
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring
61
+ * Metrics with Amazon CloudWatch</a>
63
62
  * </p>
64
63
  * </li>
65
64
  * </ul>
@@ -32,19 +32,18 @@ declare const GetBucketNotificationConfigurationCommand_base: {
32
32
  * </note>
33
33
  * <p>Returns the notification configuration of a bucket.</p>
34
34
  * <p>If notifications are not enabled on the bucket, the action returns an empty
35
- * <code>NotificationConfiguration</code> element.</p>
36
- * <p>By default, you must be the bucket owner to read the notification configuration of a
37
- * bucket. However, the bucket owner can use a bucket policy to grant permission to other
38
- * users to read this configuration with the <code>s3:GetBucketNotification</code>
39
- * permission.</p>
35
+ * <code>NotificationConfiguration</code> element.</p>
36
+ * <p>By default, you must be the bucket owner to read the notification configuration of a bucket.
37
+ * However, the bucket owner can use a bucket policy to grant permission to other users to read this
38
+ * configuration with the <code>s3:GetBucketNotification</code> permission.</p>
40
39
  * <p>When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.</p>
41
40
  * <p>When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
42
41
  * If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
43
42
  * For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
44
43
  * Error Codes</a>.</p>
45
- * <p>For more information about setting and reading the notification configuration on a
46
- * 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
47
- * policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>.</p>
44
+ * <p>For more information about setting and reading the notification configuration on a bucket, see
45
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification
46
+ * of 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>
48
47
  * <p>The following action is related to <code>GetBucketNotification</code>:</p>
49
48
  * <ul>
50
49
  * <li>
@@ -30,24 +30,25 @@ declare const GetBucketOwnershipControlsCommand_base: {
30
30
  * <note>
31
31
  * <p>This operation is not supported for directory buckets.</p>
32
32
  * </note>
33
- * <p>Retrieves <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
34
- * must have the <code>s3:GetBucketOwnershipControls</code> permission. For more information
35
- * about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying permissions in a
36
- * policy</a>. </p>
33
+ * <p>Retrieves <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have
34
+ * the <code>s3:GetBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions,
35
+ * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying
36
+ * permissions in a policy</a>. </p>
37
37
  * <note>
38
38
  * <p>A bucket doesn't have <code>OwnershipControls</code> settings in the following cases:</p>
39
39
  * <ul>
40
40
  * <li>
41
- * <p>The bucket was created before the <code>BucketOwnerEnforced</code> ownership setting was introduced and you've never explicitly applied this value</p>
41
+ * <p>The bucket was created before the <code>BucketOwnerEnforced</code> ownership setting was
42
+ * introduced and you've never explicitly applied this value</p>
42
43
  * </li>
43
44
  * <li>
44
- * <p>You've manually deleted the bucket ownership control value using the <code>DeleteBucketOwnershipControls</code> API operation.</p>
45
+ * <p>You've manually deleted the bucket ownership control value using the
46
+ * <code>DeleteBucketOwnershipControls</code> API operation.</p>
45
47
  * </li>
46
48
  * </ul>
47
49
  * <p>By default, Amazon S3 sets <code>OwnershipControls</code> for all newly created buckets.</p>
48
50
  * </note>
49
- * <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
50
- * Ownership</a>. </p>
51
+ * <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>
51
52
  * <p>The following operations are related to <code>GetBucketOwnershipControls</code>:</p>
52
53
  * <ul>
53
54
  * <li>