@aws-sdk/client-s3 3.298.0 → 3.300.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/dist-types/commands/AbortMultipartUploadCommand.d.ts +7 -0
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +26 -0
- package/dist-types/commands/CopyObjectCommand.d.ts +45 -0
- package/dist-types/commands/CreateBucketCommand.d.ts +14 -0
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +34 -0
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +5 -0
- package/dist-types/commands/DeleteBucketCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +5 -0
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +5 -0
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +4 -0
- package/dist-types/commands/DeleteObjectCommand.d.ts +9 -0
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +6 -0
- package/dist-types/commands/DeleteObjectsCommand.d.ts +17 -0
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketAclCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +5 -0
- package/dist-types/commands/GetBucketCorsCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +5 -0
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +5 -0
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +4 -0
- package/dist-types/commands/GetObjectAclCommand.d.ts +7 -0
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +15 -0
- package/dist-types/commands/GetObjectCommand.d.ts +23 -0
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +7 -0
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +7 -0
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +7 -0
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +6 -0
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +4 -0
- package/dist-types/commands/HeadBucketCommand.d.ts +4 -0
- package/dist-types/commands/HeadObjectCommand.d.ts +17 -0
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +5 -0
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +4 -0
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +5 -0
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +5 -0
- package/dist-types/commands/ListBucketsCommand.d.ts +1 -0
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +10 -0
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +10 -0
- package/dist-types/commands/ListObjectsCommand.d.ts +10 -0
- package/dist-types/commands/ListObjectsV2Command.d.ts +12 -0
- package/dist-types/commands/ListPartsCommand.d.ts +12 -0
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +8 -0
- package/dist-types/commands/PutBucketAclCommand.d.ts +30 -0
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +37 -0
- package/dist-types/commands/PutBucketCorsCommand.d.ts +26 -0
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +17 -0
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +30 -0
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +33 -0
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +60 -0
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +24 -0
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +26 -0
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +65 -0
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +12 -0
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +8 -0
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +71 -0
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +9 -0
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +14 -0
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +11 -0
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +33 -0
- package/dist-types/commands/PutObjectAclCommand.d.ts +33 -0
- package/dist-types/commands/PutObjectCommand.d.ts +41 -0
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +12 -0
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +18 -0
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +14 -0
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +17 -0
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +12 -0
- package/dist-types/commands/RestoreObjectCommand.d.ts +88 -0
- package/dist-types/commands/SelectObjectContentCommand.d.ts +45 -0
- package/dist-types/commands/UploadPartCommand.d.ts +19 -0
- package/dist-types/commands/UploadPartCopyCommand.d.ts +21 -0
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +44 -0
- package/package.json +16 -16
|
@@ -48,6 +48,10 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
|
|
|
48
48
|
* import { S3Client, GetBucketVersioningCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
49
49
|
* // const { S3Client, GetBucketVersioningCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
50
50
|
* const client = new S3Client(config);
|
|
51
|
+
* const input = {
|
|
52
|
+
* Bucket: "STRING_VALUE", // required
|
|
53
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
54
|
+
* };
|
|
51
55
|
* const command = new GetBucketVersioningCommand(input);
|
|
52
56
|
* const response = await client.send(command);
|
|
53
57
|
* ```
|
|
@@ -46,6 +46,10 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _
|
|
|
46
46
|
* import { S3Client, GetBucketWebsiteCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
47
47
|
* // const { S3Client, GetBucketWebsiteCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
48
48
|
* const client = new S3Client(config);
|
|
49
|
+
* const input = {
|
|
50
|
+
* Bucket: "STRING_VALUE", // required
|
|
51
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
52
|
+
* };
|
|
49
53
|
* const command = new GetBucketWebsiteCommand(input);
|
|
50
54
|
* const response = await client.send(command);
|
|
51
55
|
* ```
|
|
@@ -66,6 +66,13 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
|
|
|
66
66
|
* import { S3Client, GetObjectAclCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
67
67
|
* // const { S3Client, GetObjectAclCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
68
68
|
* const client = new S3Client(config);
|
|
69
|
+
* const input = {
|
|
70
|
+
* Bucket: "STRING_VALUE", // required
|
|
71
|
+
* Key: "STRING_VALUE", // required
|
|
72
|
+
* VersionId: "STRING_VALUE",
|
|
73
|
+
* RequestPayer: "requester",
|
|
74
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
75
|
+
* };
|
|
69
76
|
* const command = new GetObjectAclCommand(input);
|
|
70
77
|
* const response = await client.send(command);
|
|
71
78
|
* ```
|
|
@@ -175,6 +175,21 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
|
|
|
175
175
|
* import { S3Client, GetObjectAttributesCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
176
176
|
* // const { S3Client, GetObjectAttributesCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
177
177
|
* const client = new S3Client(config);
|
|
178
|
+
* const input = {
|
|
179
|
+
* Bucket: "STRING_VALUE", // required
|
|
180
|
+
* Key: "STRING_VALUE", // required
|
|
181
|
+
* VersionId: "STRING_VALUE",
|
|
182
|
+
* MaxParts: Number("int"),
|
|
183
|
+
* PartNumberMarker: "STRING_VALUE",
|
|
184
|
+
* SSECustomerAlgorithm: "STRING_VALUE",
|
|
185
|
+
* SSECustomerKey: "STRING_VALUE",
|
|
186
|
+
* SSECustomerKeyMD5: "STRING_VALUE",
|
|
187
|
+
* RequestPayer: "requester",
|
|
188
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
189
|
+
* ObjectAttributes: [ // required
|
|
190
|
+
* "ETag" || "Checksum" || "ObjectParts" || "StorageClass" || "ObjectSize",
|
|
191
|
+
* ],
|
|
192
|
+
* };
|
|
178
193
|
* const command = new GetObjectAttributesCommand(input);
|
|
179
194
|
* const response = await client.send(command);
|
|
180
195
|
* ```
|
|
@@ -187,6 +187,29 @@ export interface GetObjectCommandOutput extends __WithSdkStreamMixin<GetObjectOu
|
|
|
187
187
|
* import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
188
188
|
* // const { S3Client, GetObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
189
189
|
* const client = new S3Client(config);
|
|
190
|
+
* const input = {
|
|
191
|
+
* Bucket: "STRING_VALUE", // required
|
|
192
|
+
* IfMatch: "STRING_VALUE",
|
|
193
|
+
* IfModifiedSince: new Date("TIMESTAMP"),
|
|
194
|
+
* IfNoneMatch: "STRING_VALUE",
|
|
195
|
+
* IfUnmodifiedSince: new Date("TIMESTAMP"),
|
|
196
|
+
* Key: "STRING_VALUE", // required
|
|
197
|
+
* Range: "STRING_VALUE",
|
|
198
|
+
* ResponseCacheControl: "STRING_VALUE",
|
|
199
|
+
* ResponseContentDisposition: "STRING_VALUE",
|
|
200
|
+
* ResponseContentEncoding: "STRING_VALUE",
|
|
201
|
+
* ResponseContentLanguage: "STRING_VALUE",
|
|
202
|
+
* ResponseContentType: "STRING_VALUE",
|
|
203
|
+
* ResponseExpires: new Date("TIMESTAMP"),
|
|
204
|
+
* VersionId: "STRING_VALUE",
|
|
205
|
+
* SSECustomerAlgorithm: "STRING_VALUE",
|
|
206
|
+
* SSECustomerKey: "STRING_VALUE",
|
|
207
|
+
* SSECustomerKeyMD5: "STRING_VALUE",
|
|
208
|
+
* RequestPayer: "requester",
|
|
209
|
+
* PartNumber: Number("int"),
|
|
210
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
211
|
+
* ChecksumMode: "ENABLED",
|
|
212
|
+
* };
|
|
190
213
|
* const command = new GetObjectCommand(input);
|
|
191
214
|
* const response = await client.send(command);
|
|
192
215
|
* ```
|
|
@@ -36,6 +36,13 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu
|
|
|
36
36
|
* import { S3Client, GetObjectLegalHoldCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
37
37
|
* // const { S3Client, GetObjectLegalHoldCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
38
38
|
* const client = new S3Client(config);
|
|
39
|
+
* const input = {
|
|
40
|
+
* Bucket: "STRING_VALUE", // required
|
|
41
|
+
* Key: "STRING_VALUE", // required
|
|
42
|
+
* VersionId: "STRING_VALUE",
|
|
43
|
+
* RequestPayer: "requester",
|
|
44
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
45
|
+
* };
|
|
39
46
|
* const command = new GetObjectLegalHoldCommand(input);
|
|
40
47
|
* const response = await client.send(command);
|
|
41
48
|
* ```
|
|
@@ -37,6 +37,10 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo
|
|
|
37
37
|
* import { S3Client, GetObjectLockConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
38
38
|
* // const { S3Client, GetObjectLockConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
39
39
|
* const client = new S3Client(config);
|
|
40
|
+
* const input = {
|
|
41
|
+
* Bucket: "STRING_VALUE", // required
|
|
42
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
43
|
+
* };
|
|
40
44
|
* const command = new GetObjectLockConfigurationCommand(input);
|
|
41
45
|
* const response = await client.send(command);
|
|
42
46
|
* ```
|
|
@@ -35,6 +35,13 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
|
|
|
35
35
|
* import { S3Client, GetObjectRetentionCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
36
36
|
* // const { S3Client, GetObjectRetentionCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
37
37
|
* const client = new S3Client(config);
|
|
38
|
+
* const input = {
|
|
39
|
+
* Bucket: "STRING_VALUE", // required
|
|
40
|
+
* Key: "STRING_VALUE", // required
|
|
41
|
+
* VersionId: "STRING_VALUE",
|
|
42
|
+
* RequestPayer: "requester",
|
|
43
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
44
|
+
* };
|
|
38
45
|
* const command = new GetObjectRetentionCommand(input);
|
|
39
46
|
* const response = await client.send(command);
|
|
40
47
|
* ```
|
|
@@ -54,6 +54,13 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
|
|
|
54
54
|
* import { S3Client, GetObjectTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
55
55
|
* // const { S3Client, GetObjectTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
56
56
|
* const client = new S3Client(config);
|
|
57
|
+
* const input = {
|
|
58
|
+
* Bucket: "STRING_VALUE", // required
|
|
59
|
+
* Key: "STRING_VALUE", // required
|
|
60
|
+
* VersionId: "STRING_VALUE",
|
|
61
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
62
|
+
* RequestPayer: "requester",
|
|
63
|
+
* };
|
|
57
64
|
* const command = new GetObjectTaggingCommand(input);
|
|
58
65
|
* const response = await client.send(command);
|
|
59
66
|
* ```
|
|
@@ -42,6 +42,12 @@ export interface GetObjectTorrentCommandOutput extends __WithSdkStreamMixin<GetO
|
|
|
42
42
|
* import { S3Client, GetObjectTorrentCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
43
43
|
* // const { S3Client, GetObjectTorrentCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
44
44
|
* const client = new S3Client(config);
|
|
45
|
+
* const input = {
|
|
46
|
+
* Bucket: "STRING_VALUE", // required
|
|
47
|
+
* Key: "STRING_VALUE", // required
|
|
48
|
+
* RequestPayer: "requester",
|
|
49
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
50
|
+
* };
|
|
45
51
|
* const command = new GetObjectTorrentCommand(input);
|
|
46
52
|
* const response = await client.send(command);
|
|
47
53
|
* ```
|
|
@@ -62,6 +62,10 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
|
|
|
62
62
|
* import { S3Client, GetPublicAccessBlockCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
63
63
|
* // const { S3Client, GetPublicAccessBlockCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
64
64
|
* const client = new S3Client(config);
|
|
65
|
+
* const input = {
|
|
66
|
+
* Bucket: "STRING_VALUE", // required
|
|
67
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
68
|
+
* };
|
|
65
69
|
* const command = new GetPublicAccessBlockCommand(input);
|
|
66
70
|
* const response = await client.send(command);
|
|
67
71
|
* ```
|
|
@@ -36,6 +36,10 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {
|
|
|
36
36
|
* import { S3Client, HeadBucketCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
37
37
|
* // const { S3Client, HeadBucketCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
38
38
|
* const client = new S3Client(config);
|
|
39
|
+
* const input = {
|
|
40
|
+
* Bucket: "STRING_VALUE", // required
|
|
41
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
42
|
+
* };
|
|
39
43
|
* const command = new HeadBucketCommand(input);
|
|
40
44
|
* const response = await client.send(command);
|
|
41
45
|
* ```
|
|
@@ -135,6 +135,23 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea
|
|
|
135
135
|
* import { S3Client, HeadObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
136
136
|
* // const { S3Client, HeadObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
137
137
|
* const client = new S3Client(config);
|
|
138
|
+
* const input = {
|
|
139
|
+
* Bucket: "STRING_VALUE", // required
|
|
140
|
+
* IfMatch: "STRING_VALUE",
|
|
141
|
+
* IfModifiedSince: new Date("TIMESTAMP"),
|
|
142
|
+
* IfNoneMatch: "STRING_VALUE",
|
|
143
|
+
* IfUnmodifiedSince: new Date("TIMESTAMP"),
|
|
144
|
+
* Key: "STRING_VALUE", // required
|
|
145
|
+
* Range: "STRING_VALUE",
|
|
146
|
+
* VersionId: "STRING_VALUE",
|
|
147
|
+
* SSECustomerAlgorithm: "STRING_VALUE",
|
|
148
|
+
* SSECustomerKey: "STRING_VALUE",
|
|
149
|
+
* SSECustomerKeyMD5: "STRING_VALUE",
|
|
150
|
+
* RequestPayer: "requester",
|
|
151
|
+
* PartNumber: Number("int"),
|
|
152
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
153
|
+
* ChecksumMode: "ENABLED",
|
|
154
|
+
* };
|
|
138
155
|
* const command = new HeadObjectCommand(input);
|
|
139
156
|
* const response = await client.send(command);
|
|
140
157
|
* ```
|
|
@@ -61,6 +61,11 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput extends ListBuck
|
|
|
61
61
|
* import { S3Client, ListBucketAnalyticsConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
62
62
|
* // const { S3Client, ListBucketAnalyticsConfigurationsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
63
63
|
* const client = new S3Client(config);
|
|
64
|
+
* const input = {
|
|
65
|
+
* Bucket: "STRING_VALUE", // required
|
|
66
|
+
* ContinuationToken: "STRING_VALUE",
|
|
67
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
68
|
+
* };
|
|
64
69
|
* const command = new ListBucketAnalyticsConfigurationsCommand(input);
|
|
65
70
|
* const response = await client.send(command);
|
|
66
71
|
* ```
|
|
@@ -48,6 +48,10 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput extends
|
|
|
48
48
|
* import { S3Client, ListBucketIntelligentTieringConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
49
49
|
* // const { S3Client, ListBucketIntelligentTieringConfigurationsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
50
50
|
* const client = new S3Client(config);
|
|
51
|
+
* const input = {
|
|
52
|
+
* Bucket: "STRING_VALUE", // required
|
|
53
|
+
* ContinuationToken: "STRING_VALUE",
|
|
54
|
+
* };
|
|
51
55
|
* const command = new ListBucketIntelligentTieringConfigurationsCommand(input);
|
|
52
56
|
* const response = await client.send(command);
|
|
53
57
|
* ```
|
|
@@ -60,6 +60,11 @@ export interface ListBucketInventoryConfigurationsCommandOutput extends ListBuck
|
|
|
60
60
|
* import { S3Client, ListBucketInventoryConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
61
61
|
* // const { S3Client, ListBucketInventoryConfigurationsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
62
62
|
* const client = new S3Client(config);
|
|
63
|
+
* const input = {
|
|
64
|
+
* Bucket: "STRING_VALUE", // required
|
|
65
|
+
* ContinuationToken: "STRING_VALUE",
|
|
66
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
67
|
+
* };
|
|
63
68
|
* const command = new ListBucketInventoryConfigurationsCommand(input);
|
|
64
69
|
* const response = await client.send(command);
|
|
65
70
|
* ```
|
|
@@ -62,6 +62,11 @@ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucket
|
|
|
62
62
|
* import { S3Client, ListBucketMetricsConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
63
63
|
* // const { S3Client, ListBucketMetricsConfigurationsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
64
64
|
* const client = new S3Client(config);
|
|
65
|
+
* const input = {
|
|
66
|
+
* Bucket: "STRING_VALUE", // required
|
|
67
|
+
* ContinuationToken: "STRING_VALUE",
|
|
68
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
69
|
+
* };
|
|
65
70
|
* const command = new ListBucketMetricsConfigurationsCommand(input);
|
|
66
71
|
* const response = await client.send(command);
|
|
67
72
|
* ```
|
|
@@ -27,6 +27,7 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
|
|
|
27
27
|
* import { S3Client, ListBucketsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
28
28
|
* // const { S3Client, ListBucketsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
29
29
|
* const client = new S3Client(config);
|
|
30
|
+
* const input = {};
|
|
30
31
|
* const command = new ListBucketsCommand(input);
|
|
31
32
|
* const response = await client.send(command);
|
|
32
33
|
* ```
|
|
@@ -71,6 +71,16 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
|
|
|
71
71
|
* import { S3Client, ListMultipartUploadsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
72
72
|
* // const { S3Client, ListMultipartUploadsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
73
73
|
* const client = new S3Client(config);
|
|
74
|
+
* const input = {
|
|
75
|
+
* Bucket: "STRING_VALUE", // required
|
|
76
|
+
* Delimiter: "STRING_VALUE",
|
|
77
|
+
* EncodingType: "url",
|
|
78
|
+
* KeyMarker: "STRING_VALUE",
|
|
79
|
+
* MaxUploads: Number("int"),
|
|
80
|
+
* Prefix: "STRING_VALUE",
|
|
81
|
+
* UploadIdMarker: "STRING_VALUE",
|
|
82
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
83
|
+
* };
|
|
74
84
|
* const command = new ListMultipartUploadsCommand(input);
|
|
75
85
|
* const response = await client.send(command);
|
|
76
86
|
* ```
|
|
@@ -64,6 +64,16 @@ export interface ListObjectVersionsCommandOutput extends ListObjectVersionsOutpu
|
|
|
64
64
|
* import { S3Client, ListObjectVersionsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
65
65
|
* // const { S3Client, ListObjectVersionsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
66
66
|
* const client = new S3Client(config);
|
|
67
|
+
* const input = {
|
|
68
|
+
* Bucket: "STRING_VALUE", // required
|
|
69
|
+
* Delimiter: "STRING_VALUE",
|
|
70
|
+
* EncodingType: "url",
|
|
71
|
+
* KeyMarker: "STRING_VALUE",
|
|
72
|
+
* MaxKeys: Number("int"),
|
|
73
|
+
* Prefix: "STRING_VALUE",
|
|
74
|
+
* VersionIdMarker: "STRING_VALUE",
|
|
75
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
76
|
+
* };
|
|
67
77
|
* const command = new ListObjectVersionsCommand(input);
|
|
68
78
|
* const response = await client.send(command);
|
|
69
79
|
* ```
|
|
@@ -61,6 +61,16 @@ export interface ListObjectsCommandOutput extends ListObjectsOutput, __MetadataB
|
|
|
61
61
|
* import { S3Client, ListObjectsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
62
62
|
* // const { S3Client, ListObjectsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
63
63
|
* const client = new S3Client(config);
|
|
64
|
+
* const input = {
|
|
65
|
+
* Bucket: "STRING_VALUE", // required
|
|
66
|
+
* Delimiter: "STRING_VALUE",
|
|
67
|
+
* EncodingType: "url",
|
|
68
|
+
* Marker: "STRING_VALUE",
|
|
69
|
+
* MaxKeys: Number("int"),
|
|
70
|
+
* Prefix: "STRING_VALUE",
|
|
71
|
+
* RequestPayer: "requester",
|
|
72
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
73
|
+
* };
|
|
64
74
|
* const command = new ListObjectsCommand(input);
|
|
65
75
|
* const response = await client.send(command);
|
|
66
76
|
* ```
|
|
@@ -63,6 +63,18 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
|
|
|
63
63
|
* import { S3Client, ListObjectsV2Command } from "@aws-sdk/client-s3"; // ES Modules import
|
|
64
64
|
* // const { S3Client, ListObjectsV2Command } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
65
65
|
* const client = new S3Client(config);
|
|
66
|
+
* const input = {
|
|
67
|
+
* Bucket: "STRING_VALUE", // required
|
|
68
|
+
* Delimiter: "STRING_VALUE",
|
|
69
|
+
* EncodingType: "url",
|
|
70
|
+
* MaxKeys: Number("int"),
|
|
71
|
+
* Prefix: "STRING_VALUE",
|
|
72
|
+
* ContinuationToken: "STRING_VALUE",
|
|
73
|
+
* FetchOwner: true || false,
|
|
74
|
+
* StartAfter: "STRING_VALUE",
|
|
75
|
+
* RequestPayer: "requester",
|
|
76
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
77
|
+
* };
|
|
66
78
|
* const command = new ListObjectsV2Command(input);
|
|
67
79
|
* const response = await client.send(command);
|
|
68
80
|
* ```
|
|
@@ -75,6 +75,18 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare
|
|
|
75
75
|
* import { S3Client, ListPartsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
76
76
|
* // const { S3Client, ListPartsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
77
77
|
* const client = new S3Client(config);
|
|
78
|
+
* const input = {
|
|
79
|
+
* Bucket: "STRING_VALUE", // required
|
|
80
|
+
* Key: "STRING_VALUE", // required
|
|
81
|
+
* MaxParts: Number("int"),
|
|
82
|
+
* PartNumberMarker: "STRING_VALUE",
|
|
83
|
+
* UploadId: "STRING_VALUE", // required
|
|
84
|
+
* RequestPayer: "requester",
|
|
85
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
86
|
+
* SSECustomerAlgorithm: "STRING_VALUE",
|
|
87
|
+
* SSECustomerKey: "STRING_VALUE",
|
|
88
|
+
* SSECustomerKeyMD5: "STRING_VALUE",
|
|
89
|
+
* };
|
|
78
90
|
* const command = new ListPartsCommand(input);
|
|
79
91
|
* const response = await client.send(command);
|
|
80
92
|
* ```
|
|
@@ -63,6 +63,14 @@ export interface PutBucketAccelerateConfigurationCommandOutput extends __Metadat
|
|
|
63
63
|
* import { S3Client, PutBucketAccelerateConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
64
64
|
* // const { S3Client, PutBucketAccelerateConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
65
65
|
* const client = new S3Client(config);
|
|
66
|
+
* const input = {
|
|
67
|
+
* Bucket: "STRING_VALUE", // required
|
|
68
|
+
* AccelerateConfiguration: {
|
|
69
|
+
* Status: "Enabled" || "Suspended",
|
|
70
|
+
* },
|
|
71
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
72
|
+
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
|
|
73
|
+
* };
|
|
66
74
|
* const command = new PutBucketAccelerateConfigurationCommand(input);
|
|
67
75
|
* const response = await client.send(command);
|
|
68
76
|
* ```
|
|
@@ -214,6 +214,36 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {
|
|
|
214
214
|
* import { S3Client, PutBucketAclCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
215
215
|
* // const { S3Client, PutBucketAclCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
216
216
|
* const client = new S3Client(config);
|
|
217
|
+
* const input = {
|
|
218
|
+
* ACL: "private" || "public-read" || "public-read-write" || "authenticated-read",
|
|
219
|
+
* AccessControlPolicy: {
|
|
220
|
+
* Grants: [
|
|
221
|
+
* {
|
|
222
|
+
* Grantee: {
|
|
223
|
+
* DisplayName: "STRING_VALUE",
|
|
224
|
+
* EmailAddress: "STRING_VALUE",
|
|
225
|
+
* ID: "STRING_VALUE",
|
|
226
|
+
* URI: "STRING_VALUE",
|
|
227
|
+
* Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
|
|
228
|
+
* },
|
|
229
|
+
* Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP",
|
|
230
|
+
* },
|
|
231
|
+
* ],
|
|
232
|
+
* Owner: {
|
|
233
|
+
* DisplayName: "STRING_VALUE",
|
|
234
|
+
* ID: "STRING_VALUE",
|
|
235
|
+
* },
|
|
236
|
+
* },
|
|
237
|
+
* Bucket: "STRING_VALUE", // required
|
|
238
|
+
* ContentMD5: "STRING_VALUE",
|
|
239
|
+
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
|
|
240
|
+
* GrantFullControl: "STRING_VALUE",
|
|
241
|
+
* GrantRead: "STRING_VALUE",
|
|
242
|
+
* GrantReadACP: "STRING_VALUE",
|
|
243
|
+
* GrantWrite: "STRING_VALUE",
|
|
244
|
+
* GrantWriteACP: "STRING_VALUE",
|
|
245
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
246
|
+
* };
|
|
217
247
|
* const command = new PutBucketAclCommand(input);
|
|
218
248
|
* const response = await client.send(command);
|
|
219
249
|
* ```
|
|
@@ -130,6 +130,43 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata
|
|
|
130
130
|
* import { S3Client, PutBucketAnalyticsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
131
131
|
* // const { S3Client, PutBucketAnalyticsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
132
132
|
* const client = new S3Client(config);
|
|
133
|
+
* const input = {
|
|
134
|
+
* Bucket: "STRING_VALUE", // required
|
|
135
|
+
* Id: "STRING_VALUE", // required
|
|
136
|
+
* AnalyticsConfiguration: {
|
|
137
|
+
* Id: "STRING_VALUE", // required
|
|
138
|
+
* Filter: { // Union: only one key present
|
|
139
|
+
* Prefix: "STRING_VALUE",
|
|
140
|
+
* Tag: {
|
|
141
|
+
* Key: "STRING_VALUE", // required
|
|
142
|
+
* Value: "STRING_VALUE", // required
|
|
143
|
+
* },
|
|
144
|
+
* And: {
|
|
145
|
+
* Prefix: "STRING_VALUE",
|
|
146
|
+
* Tags: [
|
|
147
|
+
* {
|
|
148
|
+
* Key: "STRING_VALUE", // required
|
|
149
|
+
* Value: "STRING_VALUE", // required
|
|
150
|
+
* },
|
|
151
|
+
* ],
|
|
152
|
+
* },
|
|
153
|
+
* },
|
|
154
|
+
* StorageClassAnalysis: {
|
|
155
|
+
* DataExport: {
|
|
156
|
+
* OutputSchemaVersion: "V_1", // required
|
|
157
|
+
* Destination: {
|
|
158
|
+
* S3BucketDestination: {
|
|
159
|
+
* Format: "CSV", // required
|
|
160
|
+
* BucketAccountId: "STRING_VALUE",
|
|
161
|
+
* Bucket: "STRING_VALUE", // required
|
|
162
|
+
* Prefix: "STRING_VALUE",
|
|
163
|
+
* },
|
|
164
|
+
* },
|
|
165
|
+
* },
|
|
166
|
+
* },
|
|
167
|
+
* },
|
|
168
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
169
|
+
* };
|
|
133
170
|
* const command = new PutBucketAnalyticsConfigurationCommand(input);
|
|
134
171
|
* const response = await client.send(command);
|
|
135
172
|
* ```
|
|
@@ -81,6 +81,32 @@ export interface PutBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
81
81
|
* import { S3Client, PutBucketCorsCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
82
82
|
* // const { S3Client, PutBucketCorsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
83
83
|
* const client = new S3Client(config);
|
|
84
|
+
* const input = {
|
|
85
|
+
* Bucket: "STRING_VALUE", // required
|
|
86
|
+
* CORSConfiguration: {
|
|
87
|
+
* CORSRules: [ // required
|
|
88
|
+
* {
|
|
89
|
+
* ID: "STRING_VALUE",
|
|
90
|
+
* AllowedHeaders: [
|
|
91
|
+
* "STRING_VALUE",
|
|
92
|
+
* ],
|
|
93
|
+
* AllowedMethods: [ // required
|
|
94
|
+
* "STRING_VALUE",
|
|
95
|
+
* ],
|
|
96
|
+
* AllowedOrigins: [ // required
|
|
97
|
+
* "STRING_VALUE",
|
|
98
|
+
* ],
|
|
99
|
+
* ExposeHeaders: [
|
|
100
|
+
* "STRING_VALUE",
|
|
101
|
+
* ],
|
|
102
|
+
* MaxAgeSeconds: Number("int"),
|
|
103
|
+
* },
|
|
104
|
+
* ],
|
|
105
|
+
* },
|
|
106
|
+
* ContentMD5: "STRING_VALUE",
|
|
107
|
+
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
|
|
108
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
109
|
+
* };
|
|
84
110
|
* const command = new PutBucketCorsCommand(input);
|
|
85
111
|
* const response = await client.send(command);
|
|
86
112
|
* ```
|
|
@@ -59,6 +59,23 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {
|
|
|
59
59
|
* import { S3Client, PutBucketEncryptionCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
60
60
|
* // const { S3Client, PutBucketEncryptionCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
61
61
|
* const client = new S3Client(config);
|
|
62
|
+
* const input = {
|
|
63
|
+
* Bucket: "STRING_VALUE", // required
|
|
64
|
+
* ContentMD5: "STRING_VALUE",
|
|
65
|
+
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
|
|
66
|
+
* ServerSideEncryptionConfiguration: {
|
|
67
|
+
* Rules: [ // required
|
|
68
|
+
* {
|
|
69
|
+
* ApplyServerSideEncryptionByDefault: {
|
|
70
|
+
* SSEAlgorithm: "AES256" || "aws:kms", // required
|
|
71
|
+
* KMSMasterKeyID: "STRING_VALUE",
|
|
72
|
+
* },
|
|
73
|
+
* BucketKeyEnabled: true || false,
|
|
74
|
+
* },
|
|
75
|
+
* ],
|
|
76
|
+
* },
|
|
77
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
78
|
+
* };
|
|
62
79
|
* const command = new PutBucketEncryptionCommand(input);
|
|
63
80
|
* const response = await client.send(command);
|
|
64
81
|
* ```
|
|
@@ -107,6 +107,36 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _
|
|
|
107
107
|
* import { S3Client, PutBucketIntelligentTieringConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
108
108
|
* // const { S3Client, PutBucketIntelligentTieringConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
109
109
|
* const client = new S3Client(config);
|
|
110
|
+
* const input = {
|
|
111
|
+
* Bucket: "STRING_VALUE", // required
|
|
112
|
+
* Id: "STRING_VALUE", // required
|
|
113
|
+
* IntelligentTieringConfiguration: {
|
|
114
|
+
* Id: "STRING_VALUE", // required
|
|
115
|
+
* Filter: {
|
|
116
|
+
* Prefix: "STRING_VALUE",
|
|
117
|
+
* Tag: {
|
|
118
|
+
* Key: "STRING_VALUE", // required
|
|
119
|
+
* Value: "STRING_VALUE", // required
|
|
120
|
+
* },
|
|
121
|
+
* And: {
|
|
122
|
+
* Prefix: "STRING_VALUE",
|
|
123
|
+
* Tags: [
|
|
124
|
+
* {
|
|
125
|
+
* Key: "STRING_VALUE", // required
|
|
126
|
+
* Value: "STRING_VALUE", // required
|
|
127
|
+
* },
|
|
128
|
+
* ],
|
|
129
|
+
* },
|
|
130
|
+
* },
|
|
131
|
+
* Status: "Enabled" || "Disabled", // required
|
|
132
|
+
* Tierings: [ // required
|
|
133
|
+
* {
|
|
134
|
+
* Days: Number("int"), // required
|
|
135
|
+
* AccessTier: "ARCHIVE_ACCESS" || "DEEP_ARCHIVE_ACCESS", // required
|
|
136
|
+
* },
|
|
137
|
+
* ],
|
|
138
|
+
* },
|
|
139
|
+
* };
|
|
110
140
|
* const command = new PutBucketIntelligentTieringConfigurationCommand(input);
|
|
111
141
|
* const response = await client.send(command);
|
|
112
142
|
* ```
|
|
@@ -124,6 +124,39 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata
|
|
|
124
124
|
* import { S3Client, PutBucketInventoryConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
125
125
|
* // const { S3Client, PutBucketInventoryConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
126
126
|
* const client = new S3Client(config);
|
|
127
|
+
* const input = {
|
|
128
|
+
* Bucket: "STRING_VALUE", // required
|
|
129
|
+
* Id: "STRING_VALUE", // required
|
|
130
|
+
* InventoryConfiguration: {
|
|
131
|
+
* Destination: {
|
|
132
|
+
* S3BucketDestination: {
|
|
133
|
+
* AccountId: "STRING_VALUE",
|
|
134
|
+
* Bucket: "STRING_VALUE", // required
|
|
135
|
+
* Format: "CSV" || "ORC" || "Parquet", // required
|
|
136
|
+
* Prefix: "STRING_VALUE",
|
|
137
|
+
* Encryption: {
|
|
138
|
+
* SSES3: {},
|
|
139
|
+
* SSEKMS: {
|
|
140
|
+
* KeyId: "STRING_VALUE", // required
|
|
141
|
+
* },
|
|
142
|
+
* },
|
|
143
|
+
* },
|
|
144
|
+
* },
|
|
145
|
+
* IsEnabled: true || false, // required
|
|
146
|
+
* Filter: {
|
|
147
|
+
* Prefix: "STRING_VALUE", // required
|
|
148
|
+
* },
|
|
149
|
+
* Id: "STRING_VALUE", // required
|
|
150
|
+
* IncludedObjectVersions: "All" || "Current", // required
|
|
151
|
+
* OptionalFields: [
|
|
152
|
+
* "Size" || "LastModifiedDate" || "StorageClass" || "ETag" || "IsMultipartUploaded" || "ReplicationStatus" || "EncryptionStatus" || "ObjectLockRetainUntilDate" || "ObjectLockMode" || "ObjectLockLegalHoldStatus" || "IntelligentTieringAccessTier" || "BucketKeyStatus" || "ChecksumAlgorithm",
|
|
153
|
+
* ],
|
|
154
|
+
* Schedule: {
|
|
155
|
+
* Frequency: "Daily" || "Weekly", // required
|
|
156
|
+
* },
|
|
157
|
+
* },
|
|
158
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
159
|
+
* };
|
|
127
160
|
* const command = new PutBucketInventoryConfigurationCommand(input);
|
|
128
161
|
* const response = await client.send(command);
|
|
129
162
|
* ```
|