@aws-sdk/client-s3 3.703.0 → 3.709.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 +24 -0
- package/dist-cjs/index.js +330 -102
- package/dist-es/S3.js +6 -0
- package/dist-es/commands/CreateBucketMetadataTableConfigurationCommand.js +32 -0
- package/dist-es/commands/DeleteBucketMetadataTableConfigurationCommand.js +26 -0
- package/dist-es/commands/GetBucketMetadataTableConfigurationCommand.js +28 -0
- package/dist-es/commands/PutBucketEncryptionCommand.js +1 -1
- package/dist-es/commands/PutBucketInventoryConfigurationCommand.js +1 -1
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +0 -12
- package/dist-es/models/models_1.js +13 -0
- package/dist-es/protocols/Aws_restXml.js +157 -0
- package/dist-types/S3.d.ts +21 -0
- package/dist-types/S3Client.d.ts +5 -2
- package/dist-types/commands/CreateBucketCommand.d.ts +13 -13
- package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +134 -0
- package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +95 -0
- package/dist-types/commands/DeleteObjectCommand.d.ts +10 -10
- package/dist-types/commands/DeleteObjectsCommand.d.ts +22 -22
- package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +111 -0
- package/dist-types/commands/GetObjectCommand.d.ts +19 -19
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +19 -19
- package/dist-types/commands/PutBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectCommand.d.ts +40 -40
- package/dist-types/commands/UploadPartCopyCommand.d.ts +13 -13
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +377 -352
- package/dist-types/models/models_1.d.ts +352 -1
- package/dist-types/protocols/Aws_restXml.d.ts +27 -0
- package/dist-types/ts3.4/S3.d.ts +69 -0
- package/dist-types/ts3.4/S3Client.d.ts +18 -0
- package/dist-types/ts3.4/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetBucketMetadataTableConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutBucketCorsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketEncryptionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketLoggingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +47 -66
- package/dist-types/ts3.4/models/models_1.d.ts +74 -0
- package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +36 -0
- package/package.json +52 -52
|
@@ -232,39 +232,39 @@ declare const CreateBucketCommand_base: {
|
|
|
232
232
|
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
233
233
|
*
|
|
234
234
|
* @public
|
|
235
|
-
* @example To create a bucket
|
|
235
|
+
* @example To create a bucket in a specific region
|
|
236
236
|
* ```javascript
|
|
237
|
-
* // The following example creates a bucket.
|
|
237
|
+
* // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
|
238
238
|
* const input = {
|
|
239
|
-
* "Bucket": "examplebucket"
|
|
239
|
+
* "Bucket": "examplebucket",
|
|
240
|
+
* "CreateBucketConfiguration": {
|
|
241
|
+
* "LocationConstraint": "eu-west-1"
|
|
242
|
+
* }
|
|
240
243
|
* };
|
|
241
244
|
* const command = new CreateBucketCommand(input);
|
|
242
245
|
* const response = await client.send(command);
|
|
243
246
|
* /* response ==
|
|
244
247
|
* {
|
|
245
|
-
* "Location": "/
|
|
248
|
+
* "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
|
|
246
249
|
* }
|
|
247
250
|
* *\/
|
|
248
|
-
* // example id: to-create-a-bucket
|
|
251
|
+
* // example id: to-create-a-bucket-in-a-specific-region-1483399072992
|
|
249
252
|
* ```
|
|
250
253
|
*
|
|
251
|
-
* @example To create a bucket
|
|
254
|
+
* @example To create a bucket
|
|
252
255
|
* ```javascript
|
|
253
|
-
* // The following example creates a bucket.
|
|
256
|
+
* // The following example creates a bucket.
|
|
254
257
|
* const input = {
|
|
255
|
-
* "Bucket": "examplebucket"
|
|
256
|
-
* "CreateBucketConfiguration": {
|
|
257
|
-
* "LocationConstraint": "eu-west-1"
|
|
258
|
-
* }
|
|
258
|
+
* "Bucket": "examplebucket"
|
|
259
259
|
* };
|
|
260
260
|
* const command = new CreateBucketCommand(input);
|
|
261
261
|
* const response = await client.send(command);
|
|
262
262
|
* /* response ==
|
|
263
263
|
* {
|
|
264
|
-
* "Location": "
|
|
264
|
+
* "Location": "/examplebucket"
|
|
265
265
|
* }
|
|
266
266
|
* *\/
|
|
267
|
-
* // example id: to-create-a-bucket
|
|
267
|
+
* // example id: to-create-a-bucket--1472851826060
|
|
268
268
|
* ```
|
|
269
269
|
*
|
|
270
270
|
*/
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CreateBucketMetadataTableConfigurationRequest } 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 CreateBucketMetadataTableConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateBucketMetadataTableConfigurationCommandInput extends CreateBucketMetadataTableConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateBucketMetadataTableConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateBucketMetadataTableConfigurationCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateBucketMetadataTableConfigurationCommand_base: {
|
|
25
|
+
new (input: CreateBucketMetadataTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBucketMetadataTableConfigurationCommandInput, CreateBucketMetadataTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateBucketMetadataTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBucketMetadataTableConfigurationCommandInput, CreateBucketMetadataTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates a metadata table configuration for a general purpose bucket. For more
|
|
31
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html">Accelerating data
|
|
32
|
+
* 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
|
|
37
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up
|
|
38
|
+
* permissions for configuring metadata tables</a> in the
|
|
39
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
40
|
+
* <p>If you also want to integrate your table bucket with Amazon Web Services analytics services so that you
|
|
41
|
+
* can query your metadata table, you need additional permissions. For more information, see
|
|
42
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-integrating-aws.html">
|
|
43
|
+
* Integrating Amazon S3 Tables with Amazon Web Services analytics services</a> in the
|
|
44
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
45
|
+
* <ul>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <code>s3:CreateBucketMetadataTableConfiguration</code>
|
|
49
|
+
* </p>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>
|
|
53
|
+
* <code>s3tables:CreateNamespace</code>
|
|
54
|
+
* </p>
|
|
55
|
+
* </li>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>
|
|
58
|
+
* <code>s3tables:GetTable</code>
|
|
59
|
+
* </p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>
|
|
63
|
+
* <code>s3tables:CreateTable</code>
|
|
64
|
+
* </p>
|
|
65
|
+
* </li>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p>
|
|
68
|
+
* <code>s3tables:PutTablePolicy</code>
|
|
69
|
+
* </p>
|
|
70
|
+
* </li>
|
|
71
|
+
* </ul>
|
|
72
|
+
* </dd>
|
|
73
|
+
* </dl>
|
|
74
|
+
* <p>The following operations are related to <code>CreateBucketMetadataTableConfiguration</code>:</p>
|
|
75
|
+
* <ul>
|
|
76
|
+
* <li>
|
|
77
|
+
* <p>
|
|
78
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html">DeleteBucketMetadataTableConfiguration</a>
|
|
79
|
+
* </p>
|
|
80
|
+
* </li>
|
|
81
|
+
* <li>
|
|
82
|
+
* <p>
|
|
83
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html">GetBucketMetadataTableConfiguration</a>
|
|
84
|
+
* </p>
|
|
85
|
+
* </li>
|
|
86
|
+
* </ul>
|
|
87
|
+
* @example
|
|
88
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
89
|
+
* ```javascript
|
|
90
|
+
* import { S3Client, CreateBucketMetadataTableConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
91
|
+
* // const { S3Client, CreateBucketMetadataTableConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
92
|
+
* const client = new S3Client(config);
|
|
93
|
+
* const input = { // CreateBucketMetadataTableConfigurationRequest
|
|
94
|
+
* Bucket: "STRING_VALUE", // required
|
|
95
|
+
* ContentMD5: "STRING_VALUE",
|
|
96
|
+
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
|
|
97
|
+
* MetadataTableConfiguration: { // MetadataTableConfiguration
|
|
98
|
+
* S3TablesDestination: { // S3TablesDestination
|
|
99
|
+
* TableBucketArn: "STRING_VALUE", // required
|
|
100
|
+
* TableName: "STRING_VALUE", // required
|
|
101
|
+
* },
|
|
102
|
+
* },
|
|
103
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
104
|
+
* };
|
|
105
|
+
* const command = new CreateBucketMetadataTableConfigurationCommand(input);
|
|
106
|
+
* const response = await client.send(command);
|
|
107
|
+
* // {};
|
|
108
|
+
*
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @param CreateBucketMetadataTableConfigurationCommandInput - {@link CreateBucketMetadataTableConfigurationCommandInput}
|
|
112
|
+
* @returns {@link CreateBucketMetadataTableConfigurationCommandOutput}
|
|
113
|
+
* @see {@link CreateBucketMetadataTableConfigurationCommandInput} for command's `input` shape.
|
|
114
|
+
* @see {@link CreateBucketMetadataTableConfigurationCommandOutput} for command's `response` shape.
|
|
115
|
+
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link S3ServiceException}
|
|
118
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
119
|
+
*
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export declare class CreateBucketMetadataTableConfigurationCommand extends CreateBucketMetadataTableConfigurationCommand_base {
|
|
123
|
+
/** @internal type navigation helper, not in runtime. */
|
|
124
|
+
protected static __types: {
|
|
125
|
+
api: {
|
|
126
|
+
input: CreateBucketMetadataTableConfigurationRequest;
|
|
127
|
+
output: {};
|
|
128
|
+
};
|
|
129
|
+
sdk: {
|
|
130
|
+
input: CreateBucketMetadataTableConfigurationCommandInput;
|
|
131
|
+
output: CreateBucketMetadataTableConfigurationCommandOutput;
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteBucketMetadataTableConfigurationRequest } 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 DeleteBucketMetadataTableConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteBucketMetadataTableConfigurationCommandInput extends DeleteBucketMetadataTableConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteBucketMetadataTableConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteBucketMetadataTableConfigurationCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteBucketMetadataTableConfigurationCommand_base: {
|
|
25
|
+
new (input: DeleteBucketMetadataTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBucketMetadataTableConfigurationCommandInput, DeleteBucketMetadataTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteBucketMetadataTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBucketMetadataTableConfigurationCommandInput, DeleteBucketMetadataTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Deletes a metadata table configuration from a general purpose bucket. For more
|
|
32
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html">Accelerating data
|
|
33
|
+
* discovery with S3 Metadata</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
34
|
+
* <dl>
|
|
35
|
+
* <dt>Permissions</dt>
|
|
36
|
+
* <dd>
|
|
37
|
+
* <p>To use this operation, you must have the <code>s3:DeleteBucketMetadataTableConfiguration</code> permission. For more
|
|
38
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up
|
|
39
|
+
* permissions for configuring metadata tables</a> in the
|
|
40
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
41
|
+
* </dd>
|
|
42
|
+
* </dl>
|
|
43
|
+
* <p>The following operations are related to <code>DeleteBucketMetadataTableConfiguration</code>:</p>
|
|
44
|
+
* <ul>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>
|
|
47
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html">CreateBucketMetadataTableConfiguration</a>
|
|
48
|
+
* </p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetadataTableConfiguration.html">GetBucketMetadataTableConfiguration</a>
|
|
53
|
+
* </p>
|
|
54
|
+
* </li>
|
|
55
|
+
* </ul>
|
|
56
|
+
* @example
|
|
57
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
58
|
+
* ```javascript
|
|
59
|
+
* import { S3Client, DeleteBucketMetadataTableConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
60
|
+
* // const { S3Client, DeleteBucketMetadataTableConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
61
|
+
* const client = new S3Client(config);
|
|
62
|
+
* const input = { // DeleteBucketMetadataTableConfigurationRequest
|
|
63
|
+
* Bucket: "STRING_VALUE", // required
|
|
64
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
65
|
+
* };
|
|
66
|
+
* const command = new DeleteBucketMetadataTableConfigurationCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* // {};
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param DeleteBucketMetadataTableConfigurationCommandInput - {@link DeleteBucketMetadataTableConfigurationCommandInput}
|
|
73
|
+
* @returns {@link DeleteBucketMetadataTableConfigurationCommandOutput}
|
|
74
|
+
* @see {@link DeleteBucketMetadataTableConfigurationCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link DeleteBucketMetadataTableConfigurationCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link S3ServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class DeleteBucketMetadataTableConfigurationCommand extends DeleteBucketMetadataTableConfigurationCommand_base {
|
|
84
|
+
/** @internal type navigation helper, not in runtime. */
|
|
85
|
+
protected static __types: {
|
|
86
|
+
api: {
|
|
87
|
+
input: DeleteBucketMetadataTableConfigurationRequest;
|
|
88
|
+
output: {};
|
|
89
|
+
};
|
|
90
|
+
sdk: {
|
|
91
|
+
input: DeleteBucketMetadataTableConfigurationCommandInput;
|
|
92
|
+
output: DeleteBucketMetadataTableConfigurationCommandOutput;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
}
|
|
@@ -165,28 +165,28 @@ declare const DeleteObjectCommand_base: {
|
|
|
165
165
|
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
166
166
|
*
|
|
167
167
|
* @public
|
|
168
|
-
* @example To delete an object
|
|
168
|
+
* @example To delete an object
|
|
169
169
|
* ```javascript
|
|
170
|
-
* // The following example deletes an object from
|
|
170
|
+
* // The following example deletes an object from an S3 bucket.
|
|
171
171
|
* const input = {
|
|
172
|
-
* "Bucket": "
|
|
173
|
-
* "Key": "
|
|
172
|
+
* "Bucket": "examplebucket",
|
|
173
|
+
* "Key": "objectkey.jpg"
|
|
174
174
|
* };
|
|
175
175
|
* const command = new DeleteObjectCommand(input);
|
|
176
176
|
* await client.send(command);
|
|
177
|
-
* // example id: to-delete-an-object-
|
|
177
|
+
* // example id: to-delete-an-object-1472850136595
|
|
178
178
|
* ```
|
|
179
179
|
*
|
|
180
|
-
* @example To delete an object
|
|
180
|
+
* @example To delete an object (from a non-versioned bucket)
|
|
181
181
|
* ```javascript
|
|
182
|
-
* // The following example deletes an object from
|
|
182
|
+
* // The following example deletes an object from a non-versioned bucket.
|
|
183
183
|
* const input = {
|
|
184
|
-
* "Bucket": "
|
|
185
|
-
* "Key": "
|
|
184
|
+
* "Bucket": "ExampleBucket",
|
|
185
|
+
* "Key": "HappyFace.jpg"
|
|
186
186
|
* };
|
|
187
187
|
* const command = new DeleteObjectCommand(input);
|
|
188
188
|
* await client.send(command);
|
|
189
|
-
* // example id: to-delete-an-object-
|
|
189
|
+
* // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
|
|
190
190
|
* ```
|
|
191
191
|
*
|
|
192
192
|
*/
|
|
@@ -225,20 +225,18 @@ declare const DeleteObjectsCommand_base: {
|
|
|
225
225
|
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
226
226
|
*
|
|
227
227
|
* @public
|
|
228
|
-
* @example To delete multiple
|
|
228
|
+
* @example To delete multiple objects from a versioned bucket
|
|
229
229
|
* ```javascript
|
|
230
|
-
* // The following example deletes objects from a bucket. The request
|
|
230
|
+
* // The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
|
231
231
|
* const input = {
|
|
232
232
|
* "Bucket": "examplebucket",
|
|
233
233
|
* "Delete": {
|
|
234
234
|
* "Objects": [
|
|
235
235
|
* {
|
|
236
|
-
* "Key": "
|
|
237
|
-
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
|
|
236
|
+
* "Key": "objectkey1"
|
|
238
237
|
* },
|
|
239
238
|
* {
|
|
240
|
-
* "Key": "
|
|
241
|
-
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
|
|
239
|
+
* "Key": "objectkey2"
|
|
242
240
|
* }
|
|
243
241
|
* ],
|
|
244
242
|
* "Quiet": false
|
|
@@ -250,31 +248,35 @@ declare const DeleteObjectsCommand_base: {
|
|
|
250
248
|
* {
|
|
251
249
|
* "Deleted": [
|
|
252
250
|
* {
|
|
253
|
-
* "
|
|
254
|
-
* "
|
|
251
|
+
* "DeleteMarker": "true",
|
|
252
|
+
* "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
|
253
|
+
* "Key": "objectkey1"
|
|
255
254
|
* },
|
|
256
255
|
* {
|
|
257
|
-
* "
|
|
258
|
-
* "
|
|
256
|
+
* "DeleteMarker": "true",
|
|
257
|
+
* "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
|
258
|
+
* "Key": "objectkey2"
|
|
259
259
|
* }
|
|
260
260
|
* ]
|
|
261
261
|
* }
|
|
262
262
|
* *\/
|
|
263
|
-
* // example id: to-delete-multiple-
|
|
263
|
+
* // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
|
|
264
264
|
* ```
|
|
265
265
|
*
|
|
266
|
-
* @example To delete multiple
|
|
266
|
+
* @example To delete multiple object versions from a versioned bucket
|
|
267
267
|
* ```javascript
|
|
268
|
-
* // The following example deletes objects from a bucket. The
|
|
268
|
+
* // The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.
|
|
269
269
|
* const input = {
|
|
270
270
|
* "Bucket": "examplebucket",
|
|
271
271
|
* "Delete": {
|
|
272
272
|
* "Objects": [
|
|
273
273
|
* {
|
|
274
|
-
* "Key": "
|
|
274
|
+
* "Key": "HappyFace.jpg",
|
|
275
|
+
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
|
|
275
276
|
* },
|
|
276
277
|
* {
|
|
277
|
-
* "Key": "
|
|
278
|
+
* "Key": "HappyFace.jpg",
|
|
279
|
+
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
|
|
278
280
|
* }
|
|
279
281
|
* ],
|
|
280
282
|
* "Quiet": false
|
|
@@ -286,19 +288,17 @@ declare const DeleteObjectsCommand_base: {
|
|
|
286
288
|
* {
|
|
287
289
|
* "Deleted": [
|
|
288
290
|
* {
|
|
289
|
-
* "
|
|
290
|
-
* "
|
|
291
|
-
* "Key": "objectkey1"
|
|
291
|
+
* "Key": "HappyFace.jpg",
|
|
292
|
+
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
|
|
292
293
|
* },
|
|
293
294
|
* {
|
|
294
|
-
* "
|
|
295
|
-
* "
|
|
296
|
-
* "Key": "objectkey2"
|
|
295
|
+
* "Key": "HappyFace.jpg",
|
|
296
|
+
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
|
|
297
297
|
* }
|
|
298
298
|
* ]
|
|
299
299
|
* }
|
|
300
300
|
* *\/
|
|
301
|
-
* // example id: to-delete-multiple-
|
|
301
|
+
* // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
|
|
302
302
|
* ```
|
|
303
303
|
*
|
|
304
304
|
*/
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetBucketMetadataTableConfigurationOutput, GetBucketMetadataTableConfigurationRequest } 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 GetBucketMetadataTableConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetBucketMetadataTableConfigurationCommandInput extends GetBucketMetadataTableConfigurationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetBucketMetadataTableConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetBucketMetadataTableConfigurationCommandOutput extends GetBucketMetadataTableConfigurationOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetBucketMetadataTableConfigurationCommand_base: {
|
|
25
|
+
new (input: GetBucketMetadataTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketMetadataTableConfigurationCommandInput, GetBucketMetadataTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetBucketMetadataTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketMetadataTableConfigurationCommandInput, GetBucketMetadataTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Retrieves the metadata table configuration for a general purpose bucket. For more
|
|
32
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html">Accelerating data
|
|
33
|
+
* discovery with S3 Metadata</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
34
|
+
* <dl>
|
|
35
|
+
* <dt>Permissions</dt>
|
|
36
|
+
* <dd>
|
|
37
|
+
* <p>To use this operation, you must have the <code>s3:GetBucketMetadataTableConfiguration</code> permission. For more
|
|
38
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up
|
|
39
|
+
* permissions for configuring metadata tables</a> in the
|
|
40
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
41
|
+
* </dd>
|
|
42
|
+
* </dl>
|
|
43
|
+
* <p>The following operations are related to <code>GetBucketMetadataTableConfiguration</code>:</p>
|
|
44
|
+
* <ul>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>
|
|
47
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html">CreateBucketMetadataTableConfiguration</a>
|
|
48
|
+
* </p>
|
|
49
|
+
* </li>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html">DeleteBucketMetadataTableConfiguration</a>
|
|
53
|
+
* </p>
|
|
54
|
+
* </li>
|
|
55
|
+
* </ul>
|
|
56
|
+
* @example
|
|
57
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
58
|
+
* ```javascript
|
|
59
|
+
* import { S3Client, GetBucketMetadataTableConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
|
|
60
|
+
* // const { S3Client, GetBucketMetadataTableConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
|
|
61
|
+
* const client = new S3Client(config);
|
|
62
|
+
* const input = { // GetBucketMetadataTableConfigurationRequest
|
|
63
|
+
* Bucket: "STRING_VALUE", // required
|
|
64
|
+
* ExpectedBucketOwner: "STRING_VALUE",
|
|
65
|
+
* };
|
|
66
|
+
* const command = new GetBucketMetadataTableConfigurationCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* // { // GetBucketMetadataTableConfigurationOutput
|
|
69
|
+
* // GetBucketMetadataTableConfigurationResult: { // GetBucketMetadataTableConfigurationResult
|
|
70
|
+
* // MetadataTableConfigurationResult: { // MetadataTableConfigurationResult
|
|
71
|
+
* // S3TablesDestinationResult: { // S3TablesDestinationResult
|
|
72
|
+
* // TableBucketArn: "STRING_VALUE", // required
|
|
73
|
+
* // TableName: "STRING_VALUE", // required
|
|
74
|
+
* // TableArn: "STRING_VALUE", // required
|
|
75
|
+
* // TableNamespace: "STRING_VALUE", // required
|
|
76
|
+
* // },
|
|
77
|
+
* // },
|
|
78
|
+
* // Status: "STRING_VALUE", // required
|
|
79
|
+
* // Error: { // ErrorDetails
|
|
80
|
+
* // ErrorCode: "STRING_VALUE",
|
|
81
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // };
|
|
85
|
+
*
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @param GetBucketMetadataTableConfigurationCommandInput - {@link GetBucketMetadataTableConfigurationCommandInput}
|
|
89
|
+
* @returns {@link GetBucketMetadataTableConfigurationCommandOutput}
|
|
90
|
+
* @see {@link GetBucketMetadataTableConfigurationCommandInput} for command's `input` shape.
|
|
91
|
+
* @see {@link GetBucketMetadataTableConfigurationCommandOutput} for command's `response` shape.
|
|
92
|
+
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link S3ServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class GetBucketMetadataTableConfigurationCommand extends GetBucketMetadataTableConfigurationCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: GetBucketMetadataTableConfigurationRequest;
|
|
104
|
+
output: GetBucketMetadataTableConfigurationOutput;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: GetBucketMetadataTableConfigurationCommandInput;
|
|
108
|
+
output: GetBucketMetadataTableConfigurationCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -302,53 +302,53 @@ declare const GetObjectCommand_base: {
|
|
|
302
302
|
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
303
303
|
*
|
|
304
304
|
* @public
|
|
305
|
-
* @example To retrieve an object
|
|
305
|
+
* @example To retrieve a byte range of an object
|
|
306
306
|
* ```javascript
|
|
307
|
-
* // The following example retrieves an object for an S3 bucket.
|
|
307
|
+
* // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
|
|
308
308
|
* const input = {
|
|
309
309
|
* "Bucket": "examplebucket",
|
|
310
|
-
* "Key": "
|
|
310
|
+
* "Key": "SampleFile.txt",
|
|
311
|
+
* "Range": "bytes=0-9"
|
|
311
312
|
* };
|
|
312
313
|
* const command = new GetObjectCommand(input);
|
|
313
314
|
* const response = await client.send(command);
|
|
314
315
|
* /* response ==
|
|
315
316
|
* {
|
|
316
317
|
* "AcceptRanges": "bytes",
|
|
317
|
-
* "ContentLength": "
|
|
318
|
-
* "
|
|
319
|
-
* "
|
|
320
|
-
* "
|
|
318
|
+
* "ContentLength": "10",
|
|
319
|
+
* "ContentRange": "bytes 0-9/43",
|
|
320
|
+
* "ContentType": "text/plain",
|
|
321
|
+
* "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
|
322
|
+
* "LastModified": "2014-10-09T22:57:28.000Z",
|
|
321
323
|
* "Metadata": {},
|
|
322
|
-
* "TagCount": 2,
|
|
323
324
|
* "VersionId": "null"
|
|
324
325
|
* }
|
|
325
326
|
* *\/
|
|
326
|
-
* // example id: to-retrieve-an-object
|
|
327
|
+
* // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
|
|
327
328
|
* ```
|
|
328
329
|
*
|
|
329
|
-
* @example To retrieve
|
|
330
|
+
* @example To retrieve an object
|
|
330
331
|
* ```javascript
|
|
331
|
-
* // The following example retrieves an object for an S3 bucket.
|
|
332
|
+
* // The following example retrieves an object for an S3 bucket.
|
|
332
333
|
* const input = {
|
|
333
334
|
* "Bucket": "examplebucket",
|
|
334
|
-
* "Key": "
|
|
335
|
-
* "Range": "bytes=0-9"
|
|
335
|
+
* "Key": "HappyFace.jpg"
|
|
336
336
|
* };
|
|
337
337
|
* const command = new GetObjectCommand(input);
|
|
338
338
|
* const response = await client.send(command);
|
|
339
339
|
* /* response ==
|
|
340
340
|
* {
|
|
341
341
|
* "AcceptRanges": "bytes",
|
|
342
|
-
* "ContentLength": "
|
|
343
|
-
* "
|
|
344
|
-
* "
|
|
345
|
-
* "
|
|
346
|
-
* "LastModified": "2014-10-09T22:57:28.000Z",
|
|
342
|
+
* "ContentLength": "3191",
|
|
343
|
+
* "ContentType": "image/jpeg",
|
|
344
|
+
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
345
|
+
* "LastModified": "2016-12-15T01:19:41.000Z",
|
|
347
346
|
* "Metadata": {},
|
|
347
|
+
* "TagCount": 2,
|
|
348
348
|
* "VersionId": "null"
|
|
349
349
|
* }
|
|
350
350
|
* *\/
|
|
351
|
-
* // example id: to-retrieve-
|
|
351
|
+
* // example id: to-retrieve-an-object-1481827837012
|
|
352
352
|
* ```
|
|
353
353
|
*
|
|
354
354
|
*/
|