@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.
- package/README.md +40 -0
- package/dist-cjs/index.js +594 -121
- package/dist-es/S3.js +10 -0
- package/dist-es/commands/CreateBucketMetadataConfigurationCommand.js +31 -0
- package/dist-es/commands/DeleteBucketMetadataConfigurationCommand.js +26 -0
- package/dist-es/commands/GetBucketMetadataConfigurationCommand.js +28 -0
- package/dist-es/commands/ListPartsCommand.js +1 -1
- package/dist-es/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.js +31 -0
- package/dist-es/commands/UpdateBucketMetadataJournalTableConfigurationCommand.js +31 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +16 -24
- package/dist-es/models/models_1.js +24 -0
- package/dist-es/protocols/Aws_restXml.js +325 -3
- package/dist-types/S3.d.ts +35 -0
- package/dist-types/S3Client.d.ts +7 -2
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +17 -22
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +46 -57
- package/dist-types/commands/CopyObjectCommand.d.ts +95 -106
- package/dist-types/commands/CreateBucketCommand.d.ts +70 -82
- package/dist-types/commands/CreateBucketMetadataConfigurationCommand.d.ts +182 -0
- package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +25 -12
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +88 -113
- package/dist-types/commands/CreateSessionCommand.d.ts +45 -50
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +7 -9
- package/dist-types/commands/DeleteBucketCommand.d.ts +10 -12
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -5
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +16 -18
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -6
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +23 -28
- package/dist-types/commands/DeleteBucketMetadataConfigurationCommand.d.ts +114 -0
- package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +26 -8
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +5 -6
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +20 -23
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +5 -7
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +2 -3
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +9 -10
- package/dist-types/commands/DeleteObjectCommand.d.ts +37 -23
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +7 -7
- package/dist-types/commands/DeleteObjectsCommand.d.ts +37 -44
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -6
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +14 -17
- package/dist-types/commands/GetBucketAclCommand.d.ts +9 -11
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +8 -11
- package/dist-types/commands/GetBucketCorsCommand.d.ts +4 -6
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -19
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +6 -8
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +28 -37
- package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -5
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketMetadataConfigurationCommand.d.ts +146 -0
- package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +25 -8
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +10 -11
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +9 -8
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +24 -29
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +5 -6
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +11 -12
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +3 -3
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +6 -7
- package/dist-types/commands/GetObjectAclCommand.d.ts +9 -11
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +55 -70
- package/dist-types/commands/GetObjectCommand.d.ts +66 -81
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +8 -10
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +4 -5
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +10 -12
- package/dist-types/commands/HeadBucketCommand.d.ts +33 -35
- package/dist-types/commands/HeadObjectCommand.d.ts +50 -62
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +14 -17
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +12 -15
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +15 -18
- package/dist-types/commands/ListBucketsCommand.d.ts +10 -9
- package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +9 -9
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +41 -49
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +7 -9
- package/dist-types/commands/ListObjectsCommand.d.ts +8 -7
- package/dist-types/commands/ListObjectsV2Command.d.ts +28 -31
- package/dist-types/commands/ListPartsCommand.d.ts +21 -24
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +14 -18
- package/dist-types/commands/PutBucketAclCommand.d.ts +51 -62
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +23 -25
- package/dist-types/commands/PutBucketCorsCommand.d.ts +23 -27
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +40 -48
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +11 -12
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +33 -37
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +51 -60
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +26 -33
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +12 -14
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +29 -35
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -6
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +24 -29
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -38
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -5
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +21 -27
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +20 -23
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +19 -18
- package/dist-types/commands/PutObjectAclCommand.d.ts +53 -61
- package/dist-types/commands/PutObjectCommand.d.ts +56 -66
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -3
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +10 -11
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +4 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +18 -24
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +10 -12
- package/dist-types/commands/RenameObjectCommand.d.ts +34 -40
- package/dist-types/commands/RestoreObjectCommand.d.ts +76 -85
- package/dist-types/commands/SelectObjectContentCommand.d.ts +50 -59
- package/dist-types/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +161 -0
- package/dist-types/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +113 -0
- package/dist-types/commands/UploadPartCommand.d.ts +64 -74
- package/dist-types/commands/UploadPartCopyCommand.d.ts +80 -96
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +29 -33
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +2688 -3603
- package/dist-types/models/models_1.d.ts +2120 -743
- package/dist-types/protocols/Aws_restXml.d.ts +45 -0
- package/dist-types/ts3.4/S3.d.ts +109 -0
- package/dist-types/ts3.4/S3Client.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateBucketMetadataConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteBucketMetadataConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetBucketMetadataConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListObjectVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListObjectsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListObjectsV2Command.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPartsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAclCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBucketMetadataInventoryTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateBucketMetadataJournalTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +93 -206
- package/dist-types/ts3.4/models/models_1.d.ts +238 -0
- package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +60 -0
- package/package.json +15 -15
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CreateBucketMetadataConfigurationRequest } 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 CreateBucketMetadataConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateBucketMetadataConfigurationCommandInput extends CreateBucketMetadataConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateBucketMetadataConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateBucketMetadataConfigurationCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateBucketMetadataConfigurationCommand_base: {
|
|
25
|
+
new (input: CreateBucketMetadataConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBucketMetadataConfigurationCommandInput, CreateBucketMetadataConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateBucketMetadataConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBucketMetadataConfigurationCommandInput, CreateBucketMetadataConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates an S3 Metadata V2 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
|
+
* <dl>
|
|
34
|
+
* <dt>Permissions</dt>
|
|
35
|
+
* <dd>
|
|
36
|
+
* <p>To use this operation, you must have the following permissions. For more information, see
|
|
37
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up permissions for configuring metadata tables</a> in the
|
|
38
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
39
|
+
* <p>If you want to encrypt your metadata tables with server-side encryption with Key Management Service
|
|
40
|
+
* (KMS) keys (SSE-KMS), you need additional permissions in your KMS key policy. For more
|
|
41
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">
|
|
42
|
+
* Setting up permissions for configuring metadata tables</a> in the
|
|
43
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
44
|
+
* <p>If you also want to integrate your table bucket with Amazon Web Services analytics services so that you can
|
|
45
|
+
* query your metadata table, you need additional permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-integrating-aws.html"> Integrating
|
|
46
|
+
* Amazon S3 Tables with Amazon Web Services analytics services</a> in the
|
|
47
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
48
|
+
* <p>To query your metadata tables, you need additional permissions. For more information, see
|
|
49
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-bucket-query-permissions.html">
|
|
50
|
+
* Permissions for querying metadata tables</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
51
|
+
* <ul>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>
|
|
54
|
+
* <code>s3:CreateBucketMetadataTableConfiguration</code>
|
|
55
|
+
* </p>
|
|
56
|
+
* <note>
|
|
57
|
+
* <p>The IAM policy action name is the same for the V1 and V2 API operations.</p>
|
|
58
|
+
* </note>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>
|
|
62
|
+
* <code>s3tables:CreateTableBucket</code>
|
|
63
|
+
* </p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>
|
|
67
|
+
* <code>s3tables:CreateNamespace</code>
|
|
68
|
+
* </p>
|
|
69
|
+
* </li>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>
|
|
72
|
+
* <code>s3tables:GetTable</code>
|
|
73
|
+
* </p>
|
|
74
|
+
* </li>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p>
|
|
77
|
+
* <code>s3tables:CreateTable</code>
|
|
78
|
+
* </p>
|
|
79
|
+
* </li>
|
|
80
|
+
* <li>
|
|
81
|
+
* <p>
|
|
82
|
+
* <code>s3tables:PutTablePolicy</code>
|
|
83
|
+
* </p>
|
|
84
|
+
* </li>
|
|
85
|
+
* <li>
|
|
86
|
+
* <p>
|
|
87
|
+
* <code>s3tables:PutTableEncryption</code>
|
|
88
|
+
* </p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>
|
|
92
|
+
* <code>kms:DescribeKey</code>
|
|
93
|
+
* </p>
|
|
94
|
+
* </li>
|
|
95
|
+
* </ul>
|
|
96
|
+
* </dd>
|
|
97
|
+
* </dl>
|
|
98
|
+
* <p>The following operations are related to <code>CreateBucketMetadataConfiguration</code>:</p>
|
|
99
|
+
* <ul>
|
|
100
|
+
* <li>
|
|
101
|
+
* <p>
|
|
102
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataConfiguration.html">DeleteBucketMetadataConfiguration</a>
|
|
103
|
+
* </p>
|
|
104
|
+
* </li>
|
|
105
|
+
* <li>
|
|
106
|
+
* <p>
|
|
107
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataConfiguration.html">GetBucketMetadataConfiguration</a>
|
|
108
|
+
* </p>
|
|
109
|
+
* </li>
|
|
110
|
+
* <li>
|
|
111
|
+
* <p>
|
|
112
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataInventoryTableConfiguration.html">UpdateBucketMetadataInventoryTableConfiguration</a>
|
|
113
|
+
* </p>
|
|
114
|
+
* </li>
|
|
115
|
+
* <li>
|
|
116
|
+
* <p>
|
|
117
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UpdateBucketMetadataJournalTableConfiguration.html">UpdateBucketMetadataJournalTableConfiguration</a>
|
|
118
|
+
* </p>
|
|
119
|
+
* </li>
|
|
120
|
+
* </ul>
|
|
121
|
+
* @example
|
|
122
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
123
|
+
* ```javascript
|
|
124
|
+
* import { S3Client, CreateBucketMetadataConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
125
|
+
* // const { S3Client, CreateBucketMetadataConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
126
|
+
* const client = new S3Client(config);
|
|
127
|
+
* const input = { // CreateBucketMetadataConfigurationRequest
|
|
128
|
+
* Bucket: "STRING_VALUE", // required
|
|
129
|
+
* ContentMD5: "STRING_VALUE",
|
|
130
|
+
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
|
|
131
|
+
* MetadataConfiguration: { // MetadataConfiguration
|
|
132
|
+
* JournalTableConfiguration: { // JournalTableConfiguration
|
|
133
|
+
* RecordExpiration: { // RecordExpiration
|
|
134
|
+
* Expiration: "ENABLED" || "DISABLED", // required
|
|
135
|
+
* Days: Number("int"),
|
|
136
|
+
* },
|
|
137
|
+
* EncryptionConfiguration: { // MetadataTableEncryptionConfiguration
|
|
138
|
+
* SseAlgorithm: "aws:kms" || "AES256", // required
|
|
139
|
+
* KmsKeyArn: "STRING_VALUE",
|
|
140
|
+
* },
|
|
141
|
+
* },
|
|
142
|
+
* InventoryTableConfiguration: { // InventoryTableConfiguration
|
|
143
|
+
* ConfigurationState: "ENABLED" || "DISABLED", // required
|
|
144
|
+
* EncryptionConfiguration: {
|
|
145
|
+
* SseAlgorithm: "aws:kms" || "AES256", // required
|
|
146
|
+
* KmsKeyArn: "STRING_VALUE",
|
|
147
|
+
* },
|
|
148
|
+
* },
|
|
149
|
+
* },
|
|
150
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
151
|
+
* };
|
|
152
|
+
* const command = new CreateBucketMetadataConfigurationCommand(input);
|
|
153
|
+
* const response = await client.send(command);
|
|
154
|
+
* // {};
|
|
155
|
+
*
|
|
156
|
+
* ```
|
|
157
|
+
*
|
|
158
|
+
* @param CreateBucketMetadataConfigurationCommandInput - {@link CreateBucketMetadataConfigurationCommandInput}
|
|
159
|
+
* @returns {@link CreateBucketMetadataConfigurationCommandOutput}
|
|
160
|
+
* @see {@link CreateBucketMetadataConfigurationCommandInput} for command's `input` shape.
|
|
161
|
+
* @see {@link CreateBucketMetadataConfigurationCommandOutput} for command's `response` shape.
|
|
162
|
+
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
163
|
+
*
|
|
164
|
+
* @throws {@link S3ServiceException}
|
|
165
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
166
|
+
*
|
|
167
|
+
*
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
export declare class CreateBucketMetadataConfigurationCommand extends CreateBucketMetadataConfigurationCommand_base {
|
|
171
|
+
/** @internal type navigation helper, not in runtime. */
|
|
172
|
+
protected static __types: {
|
|
173
|
+
api: {
|
|
174
|
+
input: CreateBucketMetadataConfigurationRequest;
|
|
175
|
+
output: {};
|
|
176
|
+
};
|
|
177
|
+
sdk: {
|
|
178
|
+
input: CreateBucketMetadataConfigurationCommandInput;
|
|
179
|
+
output: CreateBucketMetadataConfigurationCommandOutput;
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
}
|
|
@@ -27,21 +27,34 @@ declare const CreateBucketMetadataTableConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <important>
|
|
31
|
+
* <p>
|
|
32
|
+
* We recommend that you create your S3 Metadata configurations by using the V2
|
|
33
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataConfiguration.html">CreateBucketMetadataConfiguration</a> API operation. We no longer recommend using the V1
|
|
34
|
+
* <code>CreateBucketMetadataTableConfiguration</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>Creates a 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>
|
|
33
43
|
* <dl>
|
|
34
44
|
* <dt>Permissions</dt>
|
|
35
45
|
* <dd>
|
|
36
|
-
* <p>To use this operation, you must have the following permissions. For more
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
46
|
+
* <p>To use this operation, you must have the following permissions. For more information, see
|
|
47
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up permissions for configuring metadata tables</a> in the
|
|
48
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
49
|
+
* <p>If you want to encrypt your metadata tables with server-side encryption with Key Management Service
|
|
50
|
+
* (KMS) keys (SSE-KMS), you need additional permissions. For more
|
|
51
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">
|
|
52
|
+
* Setting up permissions for configuring metadata tables</a> in the
|
|
53
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
54
|
+
* <p>If you also want to integrate your table bucket with Amazon Web Services analytics services so that you can
|
|
55
|
+
* query your metadata table, you need additional permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-integrating-aws.html"> Integrating
|
|
56
|
+
* Amazon S3 Tables with Amazon Web Services analytics services</a> in the
|
|
57
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
45
58
|
* <ul>
|
|
46
59
|
* <li>
|
|
47
60
|
* <p>
|
|
@@ -35,34 +35,33 @@ declare const CreateMultipartUploadCommand_base: {
|
|
|
35
35
|
* <p>This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
36
36
|
* Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.</p>
|
|
37
37
|
* </important>
|
|
38
|
-
* <p>This action initiates a multipart upload and returns an upload ID. This upload ID is
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
38
|
+
* <p>This action initiates a multipart upload and returns an upload ID. This upload ID is used to
|
|
39
|
+
* associate all of the parts in the specific multipart upload. You specify this upload ID in each of your
|
|
40
|
+
* subsequent upload part requests (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>). You also include this upload ID in
|
|
41
|
+
* the final request to either complete or abort the multipart upload request. For more information about
|
|
42
|
+
* multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart
|
|
43
|
+
* Upload Overview</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
44
44
|
* <note>
|
|
45
|
-
* <p>After you initiate a multipart upload and upload one or more parts, to stop being
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
45
|
+
* <p>After you initiate a multipart upload and upload one or more parts, to stop being charged for
|
|
46
|
+
* storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the
|
|
47
|
+
* space used to store the parts and stops charging you for storing them only after you either complete
|
|
48
|
+
* or abort a multipart upload. </p>
|
|
49
49
|
* </note>
|
|
50
|
-
* <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
50
|
+
* <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart
|
|
51
|
+
* upload must be completed within the number of days specified in the bucket lifecycle configuration.
|
|
52
|
+
* Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the
|
|
53
|
+
* multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting
|
|
54
|
+
* Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>.</p>
|
|
55
55
|
* <note>
|
|
56
56
|
* <ul>
|
|
57
57
|
* <li>
|
|
58
58
|
* <p>
|
|
59
59
|
* <b>Directory buckets </b> -
|
|
60
|
-
*
|
|
60
|
+
* S3 Lifecycle is not supported by directory buckets.</p>
|
|
61
61
|
* </li>
|
|
62
62
|
* <li>
|
|
63
63
|
* <p>
|
|
64
|
-
* <b>Directory buckets </b> -
|
|
65
|
-
* 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>
|
|
64
|
+
* <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>
|
|
66
65
|
* </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
|
|
67
66
|
* <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
|
|
68
67
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -72,33 +71,28 @@ declare const CreateMultipartUploadCommand_base: {
|
|
|
72
71
|
* <dl>
|
|
73
72
|
* <dt>Request signing</dt>
|
|
74
73
|
* <dd>
|
|
75
|
-
* <p>For request signing, multipart upload is just a series of regular requests. You
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* Requests (Amazon Web Services Signature Version 4)</a> in the
|
|
81
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
74
|
+
* <p>For request signing, multipart upload is just a series of regular requests. You initiate a
|
|
75
|
+
* multipart upload, send one or more requests to upload parts, and then complete the multipart
|
|
76
|
+
* upload process. You sign each request individually. There is nothing special about signing
|
|
77
|
+
* multipart upload requests. For more information about signing, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services
|
|
78
|
+
* Signature Version 4)</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
82
79
|
* </dd>
|
|
83
80
|
* <dt>Permissions</dt>
|
|
84
81
|
* <dd>
|
|
85
82
|
* <ul>
|
|
86
83
|
* <li>
|
|
87
84
|
* <p>
|
|
88
|
-
* <b>General purpose bucket permissions</b> - To
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart upload API and permissions</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting data
|
|
100
|
-
* using server-side encryption with Amazon Web Services KMS</a> in the
|
|
101
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
85
|
+
* <b>General purpose bucket permissions</b> - To perform a
|
|
86
|
+
* multipart upload with encryption using an Key Management Service (KMS) KMS key, the requester must have
|
|
87
|
+
* permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey</code> actions on the
|
|
88
|
+
* key. The requester must also have permissions for the <code>kms:GenerateDataKey</code> action
|
|
89
|
+
* for the <code>CreateMultipartUpload</code> API. Then, the requester needs permissions for the
|
|
90
|
+
* <code>kms:Decrypt</code> action on the <code>UploadPart</code> and
|
|
91
|
+
* <code>UploadPartCopy</code> APIs. These permissions are required because Amazon S3 must decrypt
|
|
92
|
+
* and read data from the encrypted file parts before it completes the multipart upload. For more
|
|
93
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart upload API and
|
|
94
|
+
* permissions</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting data using server-side
|
|
95
|
+
* encryption with Amazon Web Services KMS</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
102
96
|
* </li>
|
|
103
97
|
* <li>
|
|
104
98
|
* <p>
|
|
@@ -116,36 +110,29 @@ declare const CreateMultipartUploadCommand_base: {
|
|
|
116
110
|
* <ul>
|
|
117
111
|
* <li>
|
|
118
112
|
* <p>
|
|
119
|
-
* <b>General purpose buckets</b> - Server-side
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
* the destination bucket, the encryption setting in your request takes
|
|
138
|
-
* precedence. If you choose to provide your own encryption key, the request
|
|
139
|
-
* headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> and
|
|
140
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>
|
|
141
|
-
* requests must match the headers you used in the
|
|
142
|
-
* <code>CreateMultipartUpload</code> request.</p>
|
|
113
|
+
* <b>General purpose buckets</b> - Server-side encryption is for
|
|
114
|
+
* data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers
|
|
115
|
+
* and decrypts it when you access it. Amazon S3 automatically encrypts all new objects that are
|
|
116
|
+
* uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption
|
|
117
|
+
* information in your request, the encryption setting of the uploaded parts is set to the
|
|
118
|
+
* default encryption configuration of the destination bucket. By default, all buckets have a
|
|
119
|
+
* base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys
|
|
120
|
+
* (SSE-S3). If the destination bucket has a default encryption configuration that uses
|
|
121
|
+
* server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided
|
|
122
|
+
* encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to
|
|
123
|
+
* encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to
|
|
124
|
+
* use a different type of encryption setting for the uploaded parts, you can request that Amazon S3
|
|
125
|
+
* encrypts the object with a different encryption key (such as an Amazon S3 managed key, a KMS key,
|
|
126
|
+
* or a customer-provided key). When the encryption setting in your request is different from the
|
|
127
|
+
* default encryption configuration of the destination bucket, the encryption setting in your
|
|
128
|
+
* request takes precedence. If you choose to provide your own encryption key, the request
|
|
129
|
+
* headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> requests must match the headers you used in the
|
|
130
|
+
* <code>CreateMultipartUpload</code> request.</p>
|
|
143
131
|
* <ul>
|
|
144
132
|
* <li>
|
|
145
|
-
* <p>Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* specify the following headers in the request.</p>
|
|
133
|
+
* <p>Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (<code>aws/s3</code>) and
|
|
134
|
+
* KMS customer managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to manage the keys used
|
|
135
|
+
* to encrypt data, specify the following headers in the request.</p>
|
|
149
136
|
* <ul>
|
|
150
137
|
* <li>
|
|
151
138
|
* <p>
|
|
@@ -166,53 +153,42 @@ declare const CreateMultipartUploadCommand_base: {
|
|
|
166
153
|
* <note>
|
|
167
154
|
* <ul>
|
|
168
155
|
* <li>
|
|
169
|
-
* <p>If you specify
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
* <code>x-amz-server-side-encryption-aws-kms-key-id</code>,
|
|
173
|
-
* Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code> key) in
|
|
174
|
-
* KMS to protect the data.</p>
|
|
156
|
+
* <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't
|
|
157
|
+
* provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the
|
|
158
|
+
* Amazon Web Services managed key (<code>aws/s3</code> key) in KMS to protect the data.</p>
|
|
175
159
|
* </li>
|
|
176
160
|
* <li>
|
|
177
|
-
* <p>To perform a multipart upload with encryption by using an
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
161
|
+
* <p>To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the
|
|
162
|
+
* requester must have permission to the <code>kms:Decrypt</code> and
|
|
163
|
+
* <code>kms:GenerateDataKey*</code> actions on the key. These permissions are
|
|
164
|
+
* required because Amazon S3 must decrypt and read data from the encrypted file parts
|
|
165
|
+
* before it completes the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart
|
|
166
|
+
* upload API and permissions</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting data using
|
|
167
|
+
* server-side encryption with Amazon Web Services KMS</a> in the
|
|
168
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
186
169
|
* </li>
|
|
187
170
|
* <li>
|
|
188
|
-
* <p>If your Identity and Access Management (IAM) user or role is in the same
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
* permissions on both the key policy and your IAM user or
|
|
193
|
-
* role.</p>
|
|
171
|
+
* <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the
|
|
172
|
+
* KMS key, then you must have these permissions on the key policy. If your IAM
|
|
173
|
+
* user or role is in a different account from the key, then you must have the
|
|
174
|
+
* permissions on both the key policy and your IAM user or role.</p>
|
|
194
175
|
* </li>
|
|
195
176
|
* <li>
|
|
196
|
-
* <p>All <code>GET</code> and <code>PUT</code> requests for an
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
*
|
|
201
|
-
* Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in
|
|
202
|
-
* Request Authentication</a> in the
|
|
203
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
177
|
+
* <p>All <code>GET</code> and <code>PUT</code> requests for an object protected by
|
|
178
|
+
* KMS fail if you don't make them by using Secure Sockets Layer (SSL), Transport
|
|
179
|
+
* Layer Security (TLS), or Signature Version 4. For information about configuring any
|
|
180
|
+
* of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in Request
|
|
181
|
+
* Authentication</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
204
182
|
* </li>
|
|
205
183
|
* </ul>
|
|
206
184
|
* </note>
|
|
207
|
-
* <p>For more information about server-side encryption with KMS keys
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
185
|
+
* <p>For more information about server-side encryption with KMS keys (SSE-KMS), see
|
|
186
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting Data Using Server-Side Encryption with KMS keys</a> in the
|
|
187
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
211
188
|
* </li>
|
|
212
189
|
* <li>
|
|
213
|
-
* <p>Use customer-provided encryption keys (SSE-C) – If you want to
|
|
214
|
-
*
|
|
215
|
-
* the request.</p>
|
|
190
|
+
* <p>Use customer-provided encryption keys (SSE-C) – If you want to manage your own
|
|
191
|
+
* encryption keys, provide all the following headers in the request.</p>
|
|
216
192
|
* <ul>
|
|
217
193
|
* <li>
|
|
218
194
|
* <p>
|
|
@@ -230,17 +206,17 @@ declare const CreateMultipartUploadCommand_base: {
|
|
|
230
206
|
* </p>
|
|
231
207
|
* </li>
|
|
232
208
|
* </ul>
|
|
233
|
-
* <p>For more information about server-side encryption with
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
*
|
|
209
|
+
* <p>For more information about server-side encryption with customer-provided encryption
|
|
210
|
+
* keys (SSE-C), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html"> Protecting data
|
|
211
|
+
* using server-side encryption with customer-provided encryption keys (SSE-C)</a> in
|
|
212
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
237
213
|
* </li>
|
|
238
214
|
* </ul>
|
|
239
215
|
* </li>
|
|
240
216
|
* <li>
|
|
241
217
|
* <p>
|
|
242
218
|
* <b>Directory buckets</b> -
|
|
243
|
-
*
|
|
219
|
+
* For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
|
|
244
220
|
* <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
|
|
245
221
|
* are automatically encrypted with the desired encryption settings. For more
|
|
246
222
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.</p>
|
|
@@ -258,11 +234,10 @@ declare const CreateMultipartUploadCommand_base: {
|
|
|
258
234
|
* </p>
|
|
259
235
|
* </note>
|
|
260
236
|
* <note>
|
|
261
|
-
* <p>For directory buckets, when you perform a
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
* encryption configuration of the destination bucket. </p>
|
|
237
|
+
* <p>For directory buckets, when you perform a <code>CreateMultipartUpload</code> operation
|
|
238
|
+
* and an <code>UploadPartCopy</code> operation, the request headers you provide in the
|
|
239
|
+
* <code>CreateMultipartUpload</code> request must match the default encryption configuration
|
|
240
|
+
* of the destination bucket. </p>
|
|
266
241
|
* </note>
|
|
267
242
|
* </li>
|
|
268
243
|
* </ul>
|