@aws-sdk/client-s3 3.842.0 → 3.845.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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 +19 -19
@@ -37,165 +37,152 @@ declare const CopyObjectCommand_base: {
37
37
  * </important>
38
38
  * <p>Creates a copy of an object that is already stored in Amazon S3.</p>
39
39
  * <note>
40
- * <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your
41
- * object up to 5 GB in size in a single atomic action using this API. However, to copy an
42
- * object greater than 5 GB, you must use the multipart upload Upload Part - Copy
43
- * (UploadPartCopy) API. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html">Copy Object Using the
44
- * REST Multipart Upload API</a>.</p>
40
+ * <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5
41
+ * GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you
42
+ * must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see
43
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html">Copy Object
44
+ * Using the REST Multipart Upload API</a>.</p>
45
45
  * </note>
46
- * <p>You can copy individual objects between general purpose buckets, between directory buckets,
47
- * and between general purpose buckets and directory buckets.</p>
46
+ * <p>You can copy individual objects between general purpose buckets, between directory buckets, and between
47
+ * general purpose buckets and directory buckets.</p>
48
48
  * <note>
49
49
  * <ul>
50
50
  * <li>
51
- * <p>Amazon S3 supports copy operations using Multi-Region Access Points only as a
52
- * destination when using the Multi-Region Access Point ARN. </p>
51
+ * <p>Amazon S3 supports copy operations using Multi-Region Access Points only as a destination when
52
+ * using the Multi-Region Access Point ARN. </p>
53
53
  * </li>
54
54
  * <li>
55
55
  * <p>
56
- * <b>Directory buckets </b> -
57
- * For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
56
+ * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
58
57
  * </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
59
58
  * <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
60
59
  * <i>Amazon S3 User Guide</i>.</p>
61
60
  * </li>
62
61
  * <li>
63
- * <p>VPC endpoints don't support cross-Region requests (including copies). If you're
64
- * using VPC endpoints, your source and destination buckets should be in the same
65
- * Amazon Web Services Region as your VPC endpoint.</p>
62
+ * <p>VPC endpoints don't support cross-Region requests (including copies). If you're using VPC
63
+ * endpoints, your source and destination buckets should be in the same Amazon Web Services Region as your VPC
64
+ * endpoint.</p>
66
65
  * </li>
67
66
  * </ul>
68
67
  * </note>
69
- * <p>Both the Region that you want to copy the object from and the Region that you want to
70
- * copy the object to must be enabled for your account. For more information about how to
71
- * enable a Region for your account, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone">Enable or disable a Region for standalone accounts</a> in the <i>Amazon Web Services
72
- * Account Management Guide</i>.</p>
68
+ * <p>Both the Region that you want to copy the object from and the Region that you want to copy the
69
+ * object to must be enabled for your account. For more information about how to enable a Region for your
70
+ * account, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone">Enable
71
+ * or disable a Region for standalone accounts</a> in the <i>Amazon Web Services Account Management
72
+ * Guide</i>.</p>
73
73
  * <important>
74
- * <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a
75
- * cross-Region copy using a transfer acceleration endpoint, you get a <code>400 Bad
76
- * Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer
77
- * Acceleration</a>.</p>
74
+ * <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region
75
+ * copy using a transfer acceleration endpoint, you get a <code>400 Bad Request</code> error. For more
76
+ * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p>
78
77
  * </important>
79
78
  * <dl>
80
79
  * <dt>Authentication and authorization</dt>
81
80
  * <dd>
82
- * <p>All <code>CopyObject</code> requests must be authenticated and signed by using
83
- * IAM credentials (access key ID and secret access key for the IAM identities).
84
- * All headers with the <code>x-amz-</code> prefix, including
85
- * <code>x-amz-copy-source</code>, must be signed. For more information, see
86
- * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
81
+ * <p>All <code>CopyObject</code> requests must be authenticated and signed by using IAM
82
+ * credentials (access key ID and secret access key for the IAM identities). All headers with the
83
+ * <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed. For more
84
+ * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
87
85
  * <p>
88
- * <b>Directory buckets</b> - You must use the
89
- * IAM credentials to authenticate and authorize your access to the
90
- * <code>CopyObject</code> API operation, instead of using the temporary security
91
- * credentials through the <code>CreateSession</code> API operation.</p>
92
- * <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your
93
- * behalf.</p>
86
+ * <b>Directory buckets</b> - You must use the IAM
87
+ * credentials to authenticate and authorize your access to the <code>CopyObject</code> API
88
+ * operation, instead of using the temporary security credentials through the
89
+ * <code>CreateSession</code> API operation.</p>
90
+ * <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.</p>
94
91
  * </dd>
95
92
  * <dt>Permissions</dt>
96
93
  * <dd>
97
94
  * <p>You must have <i>read</i> access to the source object and
98
- * <i>write</i> access to the destination bucket.</p>
95
+ * <i>write</i> access to the destination bucket.</p>
99
96
  * <ul>
100
97
  * <li>
101
98
  * <p>
102
- * <b>General purpose bucket permissions</b> - You
103
- * must have permissions in an IAM policy based on the source and destination
104
- * bucket types in a <code>CopyObject</code> operation.</p>
99
+ * <b>General purpose bucket permissions</b> - You must have
100
+ * permissions in an IAM policy based on the source and destination bucket types in a
101
+ * <code>CopyObject</code> operation.</p>
105
102
  * <ul>
106
103
  * <li>
107
- * <p>If the source object is in a general purpose bucket, you must have
108
- * <b>
104
+ * <p>If the source object is in a general purpose bucket, you must have <b>
109
105
  * <code>s3:GetObject</code>
110
- * </b>
111
- * permission to read the source object that is being copied. </p>
106
+ * </b> permission to read the source object that is
107
+ * being copied. </p>
112
108
  * </li>
113
109
  * <li>
114
- * <p>If the destination bucket is a general purpose bucket, you must have
115
- * <b>
110
+ * <p>If the destination bucket is a general purpose bucket, you must have <b>
116
111
  * <code>s3:PutObject</code>
117
- * </b>
118
- * permission to write the object copy to the destination bucket. </p>
112
+ * </b> permission to write the object copy to the
113
+ * destination bucket. </p>
119
114
  * </li>
120
115
  * </ul>
121
116
  * </li>
122
117
  * <li>
123
118
  * <p>
124
- * <b>Directory bucket permissions</b> -
125
- * You must have permissions in a bucket policy or an IAM identity-based policy based on the
126
- * source and destination bucket types in a <code>CopyObject</code>
127
- * operation.</p>
119
+ * <b>Directory bucket permissions</b> - You must have
120
+ * permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types
121
+ * in a <code>CopyObject</code> operation.</p>
128
122
  * <ul>
129
123
  * <li>
130
- * <p>If the source object that you want to copy is in a
131
- * directory bucket, you must have the <b>
124
+ * <p>If the source object that you want to copy is in a directory bucket, you must have
125
+ * the <b>
132
126
  * <code>s3express:CreateSession</code>
133
127
  * </b> permission in
134
- * the <code>Action</code> element of a policy to read the object. By
135
- * default, the session is in the <code>ReadWrite</code> mode. If you
136
- * want to restrict the access, you can explicitly set the
137
- * <code>s3express:SessionMode</code> condition key to
138
- * <code>ReadOnly</code> on the copy source bucket.</p>
128
+ * the <code>Action</code> element of a policy to read the object. By default, the session is
129
+ * in the <code>ReadWrite</code> mode. If you want to restrict the access, you can explicitly
130
+ * set the <code>s3express:SessionMode</code> condition key to <code>ReadOnly</code> on the
131
+ * copy source bucket.</p>
139
132
  * </li>
140
133
  * <li>
141
- * <p>If the copy destination is a directory bucket, you must have the
142
- * <b>
134
+ * <p>If the copy destination is a directory bucket, you must have the <b>
143
135
  * <code>s3express:CreateSession</code>
144
136
  * </b> permission in the
145
- * <code>Action</code> element of a policy to write the object to the
146
- * destination. The <code>s3express:SessionMode</code> condition key
147
- * can't be set to <code>ReadOnly</code> on the copy destination bucket.
148
- * </p>
137
+ * <code>Action</code> element of a policy to write the object to the destination. The
138
+ * <code>s3express:SessionMode</code> condition key can't be set to <code>ReadOnly</code>
139
+ * on the copy destination bucket. </p>
149
140
  * </li>
150
141
  * </ul>
151
142
  * <p>If the object is encrypted with SSE-KMS, you must also have the
152
- * <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions
153
- * in IAM identity-based policies and KMS key policies for the KMS
154
- * key.</p>
155
- * <p>For example policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services Identity and Access Management (IAM) identity-based policies for
156
- * S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
143
+ * <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM
144
+ * identity-based policies and KMS key policies for the KMS key.</p>
145
+ * <p>For example policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html">Example
146
+ * bucket policies for S3 Express One Zone</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html">Amazon Web Services
147
+ * Identity and Access Management (IAM) identity-based policies for S3 Express One Zone</a> in the
148
+ * <i>Amazon S3 User Guide</i>.</p>
157
149
  * </li>
158
150
  * </ul>
159
151
  * </dd>
160
152
  * <dt>Response and special errors</dt>
161
153
  * <dd>
162
- * <p>When the request is an HTTP 1.1 request, the response is chunk encoded. When
163
- * the request is not an HTTP 1.1 request, the response would not contain the
164
- * <code>Content-Length</code>. You always need to read the entire response body
165
- * to check if the copy succeeds. </p>
154
+ * <p>When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is
155
+ * not an HTTP 1.1 request, the response would not contain the <code>Content-Length</code>. You
156
+ * always need to read the entire response body to check if the copy succeeds. </p>
166
157
  * <ul>
167
158
  * <li>
168
- * <p>If the copy is successful, you receive a response with information about
169
- * the copied object.</p>
159
+ * <p>If the copy is successful, you receive a response with information about the copied
160
+ * object.</p>
170
161
  * </li>
171
162
  * <li>
172
- * <p>A copy request might return an error when Amazon S3 receives the copy request
173
- * or while Amazon S3 is copying the files. A <code>200 OK</code> response can
174
- * contain either a success or an error.</p>
163
+ * <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is
164
+ * copying the files. A <code>200 OK</code> response can contain either a success or an
165
+ * error.</p>
175
166
  * <ul>
176
167
  * <li>
177
- * <p>If the error occurs before the copy action starts, you receive a
178
- * standard Amazon S3 error.</p>
168
+ * <p>If the error occurs before the copy action starts, you receive a standard Amazon S3
169
+ * error.</p>
179
170
  * </li>
180
171
  * <li>
181
- * <p>If the error occurs during the copy operation, the error response
182
- * is embedded in the <code>200 OK</code> response. For example, in a
183
- * cross-region copy, you may encounter throttling and receive a
184
- * <code>200 OK</code> response. For more information, see <a href="https://repost.aws/knowledge-center/s3-resolve-200-internalerror">Resolve the Error 200 response when copying objects to
185
- * Amazon S3</a>. The <code>200 OK</code> status code means the copy
186
- * was accepted, but it doesn't mean the copy is complete. Another
187
- * example is when you disconnect from Amazon S3 before the copy is complete,
188
- * Amazon S3 might cancel the copy and you may receive a <code>200 OK</code>
189
- * response. You must stay connected to Amazon S3 until the entire response is
190
- * successfully received and processed.</p>
191
- * <p>If you call this API operation directly, make sure to design your
192
- * application to parse the content of the response and handle it
193
- * appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The
194
- * SDKs detect the embedded error and apply error handling per your
195
- * configuration settings (including automatically retrying the request
196
- * as appropriate). If the condition persists, the SDKs throw an
197
- * exception (or, for the SDKs that don't use exceptions, they return an
198
- * error).</p>
172
+ * <p>If the error occurs during the copy operation, the error response is embedded in the
173
+ * <code>200 OK</code> response. For example, in a cross-region copy, you may encounter
174
+ * throttling and receive a <code>200 OK</code> response. For more information, see <a href="https://repost.aws/knowledge-center/s3-resolve-200-internalerror">Resolve the Error
175
+ * 200 response when copying objects to Amazon S3</a>. The <code>200 OK</code> status code
176
+ * means the copy was accepted, but it doesn't mean the copy is complete. Another example is
177
+ * when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and
178
+ * you may receive a <code>200 OK</code> response. You must stay connected to Amazon S3 until the
179
+ * entire response is successfully received and processed.</p>
180
+ * <p>If you call this API operation directly, make sure to design your application to parse
181
+ * the content of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs
182
+ * handle this condition. The SDKs detect the embedded error and apply error handling per
183
+ * your configuration settings (including automatically retrying the request as appropriate).
184
+ * If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use
185
+ * exceptions, they return an error).</p>
199
186
  * </li>
200
187
  * </ul>
201
188
  * </li>
@@ -203,11 +190,10 @@ declare const CopyObjectCommand_base: {
203
190
  * </dd>
204
191
  * <dt>Charge</dt>
205
192
  * <dd>
206
- * <p>The copy request charge is based on the storage class and Region that you
207
- * specify for the destination object. The request can also result in a data
208
- * retrieval charge for the source if the source storage class bills for data
209
- * retrieval. If the copy source is in a different region, the data transfer is
210
- * billed to the copy source account. For pricing information, see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>.</p>
193
+ * <p>The copy request charge is based on the storage class and Region that you specify for the
194
+ * destination object. The request can also result in a data retrieval charge for the source if the
195
+ * source storage class bills for data retrieval. If the copy source is in a different region, the
196
+ * data transfer is billed to the copy source account. For pricing information, see <a href="http://aws.amazon.com/s3/pricing/">Amazon S3 pricing</a>.</p>
211
197
  * </dd>
212
198
  * <dt>HTTP Host header syntax</dt>
213
199
  * <dd>
@@ -219,9 +205,12 @@ declare const CopyObjectCommand_base: {
219
205
  * </li>
220
206
  * <li>
221
207
  * <p>
222
- * <b>Amazon S3 on Outposts</b> - When you use this action with S3 on Outposts through the REST API, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the
223
- * form <code>
224
- * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.</p>
208
+ * <b>Amazon S3 on Outposts</b> - When you use this action with
209
+ * S3 on Outposts through the REST API, you must direct requests to the S3 on Outposts hostname. The
210
+ * S3 on Outposts hostname takes the form
211
+ * <code>
212
+ * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
213
+ * The hostname isn't required when you use the Amazon Web Services CLI or SDKs.</p>
225
214
  * </li>
226
215
  * </ul>
227
216
  * </dd>
@@ -324,8 +313,8 @@ declare const CopyObjectCommand_base: {
324
313
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
325
314
  *
326
315
  * @throws {@link ObjectNotInActiveTierError} (client fault)
327
- * <p>The source object of the COPY action is not in the active tier and is only stored in
328
- * Amazon S3 Glacier.</p>
316
+ * <p>The source object of the COPY action is not in the active tier and is only stored in Amazon S3
317
+ * Glacier.</p>
329
318
  *
330
319
  * @throws {@link S3ServiceException}
331
320
  * <p>Base exception class for all service exceptions from S3 service.</p>
@@ -47,25 +47,23 @@ declare const CreateBucketCommand_base: {
47
47
  * <code>CreateBucket</code>
48
48
  * </a>.</p>
49
49
  * </note>
50
- * <p>Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services
51
- * Access Key ID to authenticate requests. Anonymous requests are never allowed to create
52
- * buckets. By creating the bucket, you become the bucket owner.</p>
53
- * <p>There are two types of buckets: general purpose buckets and directory buckets. For more
54
- * information about these bucket types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and
55
- * working with Amazon S3 buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
50
+ * <p>Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services Access Key
51
+ * ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the
52
+ * bucket, you become the bucket owner.</p>
53
+ * <p>There are two types of buckets: general purpose buckets and directory buckets. For more information about
54
+ * these bucket types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3
55
+ * buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
56
56
  * <note>
57
57
  * <ul>
58
58
  * <li>
59
59
  * <p>
60
60
  * <b>General purpose buckets</b> - If you send your
61
- * <code>CreateBucket</code> request to the <code>s3.amazonaws.com</code> global
62
- * endpoint, the request goes to the <code>us-east-1</code> Region. So the signature
63
- * calculations in Signature Version 4 must use <code>us-east-1</code> as the Region,
64
- * even if the location constraint in the request specifies another Region where the
65
- * bucket is to be created. If you create a bucket in a Region other than US East (N.
66
- * Virginia), your application must be able to handle 307 redirect. For more
67
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
68
- * buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
61
+ * <code>CreateBucket</code> request to the <code>s3.amazonaws.com</code> global endpoint, the
62
+ * request goes to the <code>us-east-1</code> Region. So the signature calculations in Signature
63
+ * Version 4 must use <code>us-east-1</code> as the Region, even if the location constraint in the
64
+ * request specifies another Region where the bucket is to be created. If you create a bucket in a
65
+ * Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For
66
+ * more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
69
67
  * </li>
70
68
  * <li>
71
69
  * <p>
@@ -83,91 +81,81 @@ declare const CreateBucketCommand_base: {
83
81
  * <ul>
84
82
  * <li>
85
83
  * <p>
86
- * <b>General purpose bucket permissions</b> - In
87
- * addition to the <code>s3:CreateBucket</code> permission, the following
88
- * permissions are required in a policy when your <code>CreateBucket</code>
89
- * request includes specific headers: </p>
84
+ * <b>General purpose bucket permissions</b> - In addition to the
85
+ * <code>s3:CreateBucket</code> permission, the following permissions are required in a policy
86
+ * when your <code>CreateBucket</code> request includes specific headers: </p>
90
87
  * <ul>
91
88
  * <li>
92
89
  * <p>
93
- * <b>Access control lists (ACLs)</b>
94
- * - In your <code>CreateBucket</code> request, if you specify an
95
- * access control list (ACL) and set it to <code>public-read</code>,
96
- * <code>public-read-write</code>, <code>authenticated-read</code>, or
97
- * if you explicitly specify any other custom ACLs, both
98
- * <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code>
99
- * permissions are required. In your <code>CreateBucket</code> request,
100
- * if you set the ACL to <code>private</code>, or if you don't specify
101
- * any ACLs, only the <code>s3:CreateBucket</code> permission is
102
- * required. </p>
90
+ * <b>Access control lists (ACLs)</b> - In your
91
+ * <code>CreateBucket</code> request, if you specify an access control list (ACL) and set
92
+ * it to <code>public-read</code>, <code>public-read-write</code>,
93
+ * <code>authenticated-read</code>, or if you explicitly specify any other custom ACLs,
94
+ * both <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code> permissions are
95
+ * required. In your <code>CreateBucket</code> request, if you set the ACL to
96
+ * <code>private</code>, or if you don't specify any ACLs, only the
97
+ * <code>s3:CreateBucket</code> permission is required. </p>
103
98
  * </li>
104
99
  * <li>
105
100
  * <p>
106
101
  * <b>Object Lock</b> - In your
107
- * <code>CreateBucket</code> request, if you set
108
- * <code>x-amz-bucket-object-lock-enabled</code> to true, the
109
- * <code>s3:PutBucketObjectLockConfiguration</code> and
110
- * <code>s3:PutBucketVersioning</code> permissions are
111
- * required.</p>
102
+ * <code>CreateBucket</code> request, if you set
103
+ * <code>x-amz-bucket-object-lock-enabled</code> to true, the
104
+ * <code>s3:PutBucketObjectLockConfiguration</code> and <code>s3:PutBucketVersioning</code>
105
+ * permissions are required.</p>
112
106
  * </li>
113
107
  * <li>
114
108
  * <p>
115
- * <b>S3 Object Ownership</b> - If
116
- * your <code>CreateBucket</code> request includes the
117
- * <code>x-amz-object-ownership</code> header, then the
118
- * <code>s3:PutBucketOwnershipControls</code> permission is
119
- * required.</p>
109
+ * <b>S3 Object Ownership</b> - If your
110
+ * <code>CreateBucket</code> request includes the <code>x-amz-object-ownership</code>
111
+ * header, then the <code>s3:PutBucketOwnershipControls</code> permission is required.</p>
120
112
  * <important>
121
- * <p> To set an ACL on a bucket as part of a
122
- * <code>CreateBucket</code> request, you must explicitly set S3
123
- * Object Ownership for the bucket to a different value than the
124
- * default, <code>BucketOwnerEnforced</code>. Additionally, if your
125
- * desired bucket ACL grants public access, you must first create the
126
- * bucket (without the bucket ACL) and then explicitly disable Block
127
- * Public Access on the bucket before using <code>PutBucketAcl</code>
128
- * to set the ACL. If you try to create a bucket with a public ACL,
129
- * the request will fail. </p>
130
- * <p> For the majority of modern use cases in S3, we recommend that
131
- * you keep all Block Public Access settings enabled and keep ACLs
132
- * disabled. If you would like to share data with users outside of
133
- * your account, you can use bucket policies as needed. For more
134
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of objects and disabling ACLs for your
135
- * bucket </a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html">Blocking public access to your Amazon S3 storage </a> in
136
- * the <i>Amazon S3 User Guide</i>. </p>
113
+ * <p> To set an ACL on a bucket as part of a <code>CreateBucket</code> request, you must
114
+ * explicitly set S3 Object Ownership for the bucket to a different value than the default,
115
+ * <code>BucketOwnerEnforced</code>. Additionally, if your desired bucket ACL grants
116
+ * public access, you must first create the bucket (without the bucket ACL) and then
117
+ * explicitly disable Block Public Access on the bucket before using
118
+ * <code>PutBucketAcl</code> to set the ACL. If you try to create a bucket with a public
119
+ * ACL, the request will fail. </p>
120
+ * <p> For the majority of modern use cases in S3, we recommend that you keep all Block
121
+ * Public Access settings enabled and keep ACLs disabled. If you would like to share data
122
+ * with users outside of your account, you can use bucket policies as needed. For more
123
+ * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of
124
+ * objects and disabling ACLs for your bucket </a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html">Blocking
125
+ * public access to your Amazon S3 storage </a> in the
126
+ * <i>Amazon S3 User Guide</i>. </p>
137
127
  * </important>
138
128
  * </li>
139
129
  * <li>
140
130
  * <p>
141
- * <b>S3 Block Public Access</b> - If
142
- * your specific use case requires granting public access to your S3
143
- * resources, you can disable Block Public Access. Specifically, you can
144
- * create a new bucket with Block Public Access enabled, then separately
145
- * call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">
131
+ * <b>S3 Block Public Access</b> - If your specific use
132
+ * case requires granting public access to your S3 resources, you can disable Block Public
133
+ * Access. Specifically, you can create a new bucket with Block Public Access enabled, then
134
+ * separately call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">
146
135
  * <code>DeletePublicAccessBlock</code>
147
136
  * </a> API. To use this operation, you must have the
148
- * <code>s3:PutBucketPublicAccessBlock</code> permission. For more
149
- * information about S3 Block Public Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html">Blocking public access to your Amazon S3 storage </a> in the
150
- * <i>Amazon S3 User Guide</i>. </p>
137
+ * <code>s3:PutBucketPublicAccessBlock</code> permission. For more information about S3
138
+ * Block Public Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html">Blocking public
139
+ * access to your Amazon S3 storage </a> in the <i>Amazon S3 User Guide</i>.
140
+ * </p>
151
141
  * </li>
152
142
  * </ul>
153
143
  * </li>
154
144
  * <li>
155
145
  * <p>
156
- * <b>Directory bucket permissions</b> -
157
- * You must have the <code>s3express:CreateBucket</code> permission in
158
- * 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.
159
- * 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>
146
+ * <b>Directory bucket permissions</b> - You must have the
147
+ * <code>s3express:CreateBucket</code> permission in an IAM identity-based policy instead of a bucket policy.
148
+ * 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. 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>
160
149
  * <important>
161
- * <p>The permissions for ACLs, Object Lock, S3 Object Ownership, and S3
162
- * Block Public Access are not supported for directory buckets. For
163
- * directory buckets, all Block Public Access settings are enabled at the
164
- * bucket level and S3 Object Ownership is set to Bucket owner enforced
165
- * (ACLs disabled). These settings can't be modified. </p>
166
- * <p>For more information about permissions for creating and working with
167
- * directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the
168
- * <i>Amazon S3 User Guide</i>. For more information about
169
- * supported S3 features for directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features">Features of S3 Express One Zone</a> in the
170
- * <i>Amazon S3 User Guide</i>.</p>
150
+ * <p>The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access
151
+ * are not supported for directory buckets. For directory buckets, all Block Public Access
152
+ * settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner
153
+ * enforced (ACLs disabled). These settings can't be modified. </p>
154
+ * <p>For more information about permissions for creating and working with directory buckets,
155
+ * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a>
156
+ * in the <i>Amazon S3 User Guide</i>. For more information about supported S3
157
+ * features for directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features">Features of
158
+ * S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
171
159
  * </important>
172
160
  * </li>
173
161
  * </ul>
@@ -241,14 +229,14 @@ declare const CreateBucketCommand_base: {
241
229
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
242
230
  *
243
231
  * @throws {@link BucketAlreadyExists} (client fault)
244
- * <p>The requested bucket name is not available. The bucket namespace is shared by all users
245
- * of the system. Select a different name and try again.</p>
232
+ * <p>The requested bucket name is not available. The bucket namespace is shared by all users of the
233
+ * system. Select a different name and try again.</p>
246
234
  *
247
235
  * @throws {@link BucketAlreadyOwnedByYou} (client fault)
248
- * <p>The bucket you tried to create already exists, and you own it. Amazon S3 returns this error
249
- * in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you
250
- * re-create an existing bucket that you already own in the North Virginia Region, Amazon S3
251
- * returns 200 OK and resets the bucket access control lists (ACLs).</p>
236
+ * <p>The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services
237
+ * Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing
238
+ * bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket
239
+ * access control lists (ACLs).</p>
252
240
  *
253
241
  * @throws {@link S3ServiceException}
254
242
  * <p>Base exception class for all service exceptions from S3 service.</p>