@aws-sdk/client-s3 3.701.0 → 3.705.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/endpoint/ruleset.js +3 -3
  3. package/dist-cjs/index.js +334 -104
  4. package/dist-es/S3.js +6 -0
  5. package/dist-es/commands/CreateBucketMetadataTableConfigurationCommand.js +32 -0
  6. package/dist-es/commands/DeleteBucketMetadataTableConfigurationCommand.js +26 -0
  7. package/dist-es/commands/GetBucketMetadataTableConfigurationCommand.js +28 -0
  8. package/dist-es/commands/PutBucketEncryptionCommand.js +1 -1
  9. package/dist-es/commands/PutBucketInventoryConfigurationCommand.js +1 -1
  10. package/dist-es/commands/index.js +3 -0
  11. package/dist-es/endpoint/ruleset.js +3 -3
  12. package/dist-es/models/models_0.js +2 -12
  13. package/dist-es/models/models_1.js +13 -0
  14. package/dist-es/protocols/Aws_restXml.js +157 -0
  15. package/dist-types/S3.d.ts +21 -0
  16. package/dist-types/S3Client.d.ts +5 -2
  17. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +4 -3
  18. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +4 -3
  19. package/dist-types/commands/CopyObjectCommand.d.ts +4 -3
  20. package/dist-types/commands/CreateBucketCommand.d.ts +19 -18
  21. package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +134 -0
  22. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +4 -3
  23. package/dist-types/commands/CreateSessionCommand.d.ts +3 -2
  24. package/dist-types/commands/DeleteBucketCommand.d.ts +4 -3
  25. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +1 -1
  26. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +3 -2
  27. package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +95 -0
  28. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +4 -3
  29. package/dist-types/commands/DeleteObjectCommand.d.ts +53 -43
  30. package/dist-types/commands/DeleteObjectsCommand.d.ts +26 -25
  31. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +1 -1
  32. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +3 -2
  33. package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +111 -0
  34. package/dist-types/commands/GetBucketPolicyCommand.d.ts +4 -3
  35. package/dist-types/commands/GetObjectAttributesCommand.d.ts +4 -3
  36. package/dist-types/commands/GetObjectCommand.d.ts +4 -3
  37. package/dist-types/commands/HeadBucketCommand.d.ts +4 -3
  38. package/dist-types/commands/HeadObjectCommand.d.ts +4 -3
  39. package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +3 -2
  40. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +4 -3
  41. package/dist-types/commands/ListObjectsV2Command.d.ts +4 -3
  42. package/dist-types/commands/ListPartsCommand.d.ts +4 -3
  43. package/dist-types/commands/PutBucketCorsCommand.d.ts +1 -1
  44. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +5 -4
  45. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  46. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
  47. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +8 -3
  48. package/dist-types/commands/PutBucketLoggingCommand.d.ts +1 -1
  49. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
  50. package/dist-types/commands/PutBucketPolicyCommand.d.ts +4 -3
  51. package/dist-types/commands/PutObjectCommand.d.ts +53 -52
  52. package/dist-types/commands/UploadPartCommand.d.ts +4 -3
  53. package/dist-types/commands/UploadPartCopyCommand.d.ts +4 -3
  54. package/dist-types/commands/index.d.ts +3 -0
  55. package/dist-types/models/models_0.d.ts +443 -411
  56. package/dist-types/models/models_1.d.ts +394 -18
  57. package/dist-types/protocols/Aws_restXml.d.ts +27 -0
  58. package/dist-types/ts3.4/S3.d.ts +69 -0
  59. package/dist-types/ts3.4/S3Client.d.ts +18 -0
  60. package/dist-types/ts3.4/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +47 -0
  61. package/dist-types/ts3.4/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +47 -0
  62. package/dist-types/ts3.4/commands/GetBucketMetadataTableConfigurationCommand.d.ts +51 -0
  63. package/dist-types/ts3.4/commands/PutBucketCorsCommand.d.ts +1 -1
  64. package/dist-types/ts3.4/commands/PutBucketEncryptionCommand.d.ts +1 -1
  65. package/dist-types/ts3.4/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  66. package/dist-types/ts3.4/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/PutBucketLoggingCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  71. package/dist-types/ts3.4/models/models_0.d.ts +49 -66
  72. package/dist-types/ts3.4/models/models_1.d.ts +74 -0
  73. package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +36 -0
  74. package/package.json +1 -1
@@ -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
+ }
@@ -30,9 +30,10 @@ declare const DeleteBucketPolicyCommand_base: {
30
30
  * <p>Deletes the policy of a specified bucket.</p>
31
31
  * <note>
32
32
  * <p>
33
- * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
33
+ * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
34
34
  * </code>. Virtual-hosted-style requests aren't supported.
35
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
35
+ * For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
36
+ * <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">Available Local Zone for directory buckets</a> in the
36
37
  * <i>Amazon S3 User Guide</i>.</p>
37
38
  * </note>
38
39
  * <dl>
@@ -76,7 +77,7 @@ declare const DeleteBucketPolicyCommand_base: {
76
77
  * <dt>HTTP Host header syntax</dt>
77
78
  * <dd>
78
79
  * <p>
79
- * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
80
+ * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
80
81
  * </dd>
81
82
  * </dl>
82
83
  * <p>The following operations are related to <code>DeleteBucketPolicy</code>
@@ -27,78 +27,88 @@ declare const DeleteObjectCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes an object from a bucket. The behavior depends on the bucket's versioning state.
31
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjects.html#DeletingObjects-best-practices">Best
32
- * practices to consider before deleting an object</a>.</p>
33
- * <p>To remove a specific version, you must use the <code>versionId</code> query parameter.
34
- * Using this query parameter permanently deletes the version. If the object deleted is a
35
- * delete marker, Amazon S3 sets the response header <code>x-amz-delete-marker</code> to true. If
36
- * the object you want to delete is in a bucket where the bucket versioning configuration is
37
- * MFA delete enabled, you must include the <code>x-amz-mfa</code> request header in the
38
- * DELETE <code>versionId</code> request. Requests that include <code>x-amz-mfa</code> must
39
- * use HTTPS. For more information about MFA delete and to see example requests, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA
40
- * delete</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample
41
- * request</a> in the <i>Amazon S3 User Guide</i>.</p>
30
+ * <p>Removes an object from a bucket. The behavior depends on the bucket's versioning state: </p>
31
+ * <ul>
32
+ * <li>
33
+ * <p>If bucket versioning is not enabled, the operation permanently deletes the object.</p>
34
+ * </li>
35
+ * <li>
36
+ * <p>If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s <code>versionId</code> in the request. For more information about versioning-enabled buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html">Deleting object versions from a versioning-enabled bucket</a>.</p>
37
+ * </li>
38
+ * <li>
39
+ * <p>If bucket versioning is suspended, the operation removes the object that has a null <code>versionId</code>, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null <code>versionId</code>, and all versions of the object have a <code>versionId</code>, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a <code>versionId</code>, you must include the object’s <code>versionId</code> in the request. For more information about versioning-suspended buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html">Deleting objects from versioning-suspended buckets</a>.</p>
40
+ * </li>
41
+ * </ul>
42
42
  * <note>
43
43
  * <ul>
44
44
  * <li>
45
- * <p>S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the
46
- * <code>versionId</code> query parameter in the request.</p>
45
+ * <p>
46
+ * <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code>
47
+ * to the <code>versionId</code> query parameter in the request.</p>
47
48
  * </li>
48
49
  * <li>
49
- * <p>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>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
50
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
50
+ * <p>
51
+ * <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>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
52
+ * </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/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
53
+ * <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">Available Local Zone for directory buckets</a> in the
51
54
  * <i>Amazon S3 User Guide</i>.</p>
52
55
  * </li>
53
- * <li>
54
- * <p>MFA delete is not supported by directory buckets.</p>
55
- * </li>
56
56
  * </ul>
57
57
  * </note>
58
+ * <p>To remove a specific version, you must use the <code>versionId</code> query parameter. Using this
59
+ * query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3
60
+ * sets the response header <code>x-amz-delete-marker</code> to true. </p>
61
+ * <p>If the object you want to delete is in a bucket where the bucket versioning
62
+ * configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request
63
+ * header in the DELETE <code>versionId</code> request. Requests that include
64
+ * <code>x-amz-mfa</code> must use HTTPS. For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a> in the <i>Amazon S3
65
+ * User Guide</i>. To see sample
66
+ * requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample
67
+ * Request</a>. </p>
68
+ * <note>
69
+ * <p>
70
+ * <b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p>
71
+ * </note>
72
+ * <p>You can delete objects by explicitly calling DELETE Object or calling
73
+ * (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) to enable Amazon S3 to remove them for you. If you want to block
74
+ * users or accounts from removing or deleting objects from your bucket, you must deny them
75
+ * the <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>, and
76
+ * <code>s3:PutLifeCycleConfiguration</code> actions. </p>
77
+ * <note>
78
+ * <p>
79
+ * <b>Directory buckets</b> - S3 Lifecycle is not supported by directory buckets.</p>
80
+ * </note>
58
81
  * <dl>
59
82
  * <dt>Permissions</dt>
60
83
  * <dd>
61
84
  * <ul>
62
85
  * <li>
63
86
  * <p>
64
- * <b>General purpose bucket permissions</b> - The
65
- * following permissions are required in your policies when your
66
- * <code>DeleteObjects</code> request includes specific headers.</p>
87
+ * <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your
88
+ * <code>DeleteObjects</code> request includes specific headers.</p>
67
89
  * <ul>
68
90
  * <li>
69
91
  * <p>
70
92
  * <b>
71
93
  * <code>s3:DeleteObject</code>
72
- * </b>
73
- * - To delete an object from a bucket, you must always have the
74
- * <code>s3:DeleteObject</code> permission.</p>
75
- * <note>
76
- * <p>You can also use <a>PutBucketLifecycle</a> to delete
77
- * objects in Amazon S3.</p>
78
- * </note>
94
+ * </b> - To delete an object from a bucket, you must always have the <code>s3:DeleteObject</code> permission.</p>
79
95
  * </li>
80
96
  * <li>
81
97
  * <p>
82
98
  * <b>
83
99
  * <code>s3:DeleteObjectVersion</code>
84
- * </b> - To delete a specific version of an object from a
85
- * versioning-enabled bucket, you must have the
86
- * <code>s3:DeleteObjectVersion</code> permission.</p>
87
- * </li>
88
- * <li>
89
- * <p>If you want to block users or accounts from removing or deleting
90
- * objects from your bucket, you must deny them the
91
- * <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>,
92
- * and <code>s3:PutLifeCycleConfiguration</code> permissions.</p>
100
+ * </b> - To delete a specific version of an object from a versioning-enabled bucket, you must have the <code>s3:DeleteObjectVersion</code> permission.</p>
93
101
  * </li>
94
102
  * </ul>
95
103
  * </li>
96
104
  * <li>
97
105
  * <p>
98
- * <b>Directory buckets permissions</b> -
99
- * To grant access to this API operation on a directory bucket, we recommend
100
- * that you use the <a>CreateSession</a> API operation for
101
- * session-based authorization.</p>
106
+ * <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
107
+ * <code>CreateSession</code>
108
+ * </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use.
109
+ * Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
110
+ * <code>CreateSession</code>
111
+ * </a>.</p>
102
112
  * </li>
103
113
  * </ul>
104
114
  * </dd>
@@ -106,7 +116,7 @@ declare const DeleteObjectCommand_base: {
106
116
  * <dd>
107
117
  * <p>
108
118
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
109
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
119
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
110
120
  * </dd>
111
121
  * </dl>
112
122
  * <p>The following action is related to <code>DeleteObject</code>:</p>
@@ -47,8 +47,9 @@ declare const DeleteObjectsCommand_base: {
47
47
  * <li>
48
48
  * <p>
49
49
  * <b>Directory buckets</b> -
50
- * 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>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
51
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
50
+ * 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>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
51
+ * </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/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
52
+ * <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">Available Local Zone for directory buckets</a> in the
52
53
  * <i>Amazon S3 User Guide</i>.</p>
53
54
  * </li>
54
55
  * </ul>
@@ -133,7 +134,7 @@ declare const DeleteObjectsCommand_base: {
133
134
  * <dd>
134
135
  * <p>
135
136
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
136
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
137
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
137
138
  * </dd>
138
139
  * </dl>
139
140
  * <p>The following operations are related to <code>DeleteObjects</code>:</p>
@@ -224,20 +225,18 @@ declare const DeleteObjectsCommand_base: {
224
225
  * <p>Base exception class for all service exceptions from S3 service.</p>
225
226
  *
226
227
  * @public
227
- * @example To delete multiple object versions from a versioned bucket
228
+ * @example To delete multiple objects from a versioned bucket
228
229
  * ```javascript
229
- * // 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.
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.
230
231
  * const input = {
231
232
  * "Bucket": "examplebucket",
232
233
  * "Delete": {
233
234
  * "Objects": [
234
235
  * {
235
- * "Key": "HappyFace.jpg",
236
- * "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
236
+ * "Key": "objectkey1"
237
237
  * },
238
238
  * {
239
- * "Key": "HappyFace.jpg",
240
- * "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
239
+ * "Key": "objectkey2"
241
240
  * }
242
241
  * ],
243
242
  * "Quiet": false
@@ -249,31 +248,35 @@ declare const DeleteObjectsCommand_base: {
249
248
  * {
250
249
  * "Deleted": [
251
250
  * {
252
- * "Key": "HappyFace.jpg",
253
- * "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
251
+ * "DeleteMarker": "true",
252
+ * "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
253
+ * "Key": "objectkey1"
254
254
  * },
255
255
  * {
256
- * "Key": "HappyFace.jpg",
257
- * "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
256
+ * "DeleteMarker": "true",
257
+ * "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
258
+ * "Key": "objectkey2"
258
259
  * }
259
260
  * ]
260
261
  * }
261
262
  * *\/
262
- * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
263
+ * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
263
264
  * ```
264
265
  *
265
- * @example To delete multiple objects from a versioned bucket
266
+ * @example To delete multiple object versions from a versioned bucket
266
267
  * ```javascript
267
- * // 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.
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.
268
269
  * const input = {
269
270
  * "Bucket": "examplebucket",
270
271
  * "Delete": {
271
272
  * "Objects": [
272
273
  * {
273
- * "Key": "objectkey1"
274
+ * "Key": "HappyFace.jpg",
275
+ * "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
274
276
  * },
275
277
  * {
276
- * "Key": "objectkey2"
278
+ * "Key": "HappyFace.jpg",
279
+ * "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
277
280
  * }
278
281
  * ],
279
282
  * "Quiet": false
@@ -285,19 +288,17 @@ declare const DeleteObjectsCommand_base: {
285
288
  * {
286
289
  * "Deleted": [
287
290
  * {
288
- * "DeleteMarker": "true",
289
- * "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
290
- * "Key": "objectkey1"
291
+ * "Key": "HappyFace.jpg",
292
+ * "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
291
293
  * },
292
294
  * {
293
- * "DeleteMarker": "true",
294
- * "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
295
- * "Key": "objectkey2"
295
+ * "Key": "HappyFace.jpg",
296
+ * "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
296
297
  * }
297
298
  * ]
298
299
  * }
299
300
  * *\/
300
- * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
301
+ * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
301
302
  * ```
302
303
  *
303
304
  */
@@ -73,7 +73,7 @@ declare const GetBucketEncryptionCommand_base: {
73
73
  * <dt>HTTP Host header syntax</dt>
74
74
  * <dd>
75
75
  * <p>
76
- * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
76
+ * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
77
77
  * </dd>
78
78
  * </dl>
79
79
  * <p>The following operations are related to <code>GetBucketEncryption</code>:</p>
@@ -74,9 +74,10 @@ declare const GetBucketLifecycleConfigurationCommand_base: {
74
74
  * <i>Amazon S3 User Guide</i>.</p>
75
75
  * <note>
76
76
  * <p>
77
- * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
77
+ * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
78
78
  * </code>. Virtual-hosted-style requests aren't supported.
79
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
79
+ * For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
80
+ * <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">Available Local Zone for directory buckets</a> in the
80
81
  * <i>Amazon S3 User Guide</i>.</p>
81
82
  * </note>
82
83
  * </li>
@@ -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
+ }
@@ -30,9 +30,10 @@ declare const GetBucketPolicyCommand_base: {
30
30
  * <p>Returns the policy of a specified bucket.</p>
31
31
  * <note>
32
32
  * <p>
33
- * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
33
+ * <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
34
34
  * </code>. Virtual-hosted-style requests aren't supported.
35
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
35
+ * For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
36
+ * <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">Available Local Zone for directory buckets</a> in the
36
37
  * <i>Amazon S3 User Guide</i>.</p>
37
38
  * </note>
38
39
  * <dl>
@@ -87,7 +88,7 @@ declare const GetBucketPolicyCommand_base: {
87
88
  * <dt>HTTP Host header syntax</dt>
88
89
  * <dd>
89
90
  * <p>
90
- * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
91
+ * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
91
92
  * </dd>
92
93
  * </dl>
93
94
  * <p>The following action is related to <code>GetBucketPolicy</code>:</p>
@@ -36,8 +36,9 @@ declare const GetObjectAttributesCommand_base: {
36
36
  * <note>
37
37
  * <p>
38
38
  * <b>Directory buckets</b> -
39
- * 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>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
40
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
39
+ * 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>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
40
+ * </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/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
41
+ * <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">Available Local Zone for directory buckets</a> in the
41
42
  * <i>Amazon S3 User Guide</i>.</p>
42
43
  * </note>
43
44
  * <dl>
@@ -192,7 +193,7 @@ declare const GetObjectAttributesCommand_base: {
192
193
  * <dd>
193
194
  * <p>
194
195
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
195
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
196
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
196
197
  * </dd>
197
198
  * </dl>
198
199
  * <p>The following actions are related to <code>GetObjectAttributes</code>:</p>
@@ -42,8 +42,9 @@ declare const GetObjectCommand_base: {
42
42
  * Header Bucket Specification</a> in the <i>Amazon S3 User Guide</i>.</p>
43
43
  * <p>
44
44
  * <b>Directory buckets</b> -
45
- * Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket--use1-az5--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
46
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
45
+ * Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket--use1-az5--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
46
+ * </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/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
47
+ * <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">Available Local Zone for directory buckets</a> in the
47
48
  * <i>Amazon S3 User Guide</i>.</p>
48
49
  * <dl>
49
50
  * <dt>Permissions</dt>
@@ -187,7 +188,7 @@ declare const GetObjectCommand_base: {
187
188
  * <dd>
188
189
  * <p>
189
190
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
190
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
191
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
191
192
  * </dd>
192
193
  * </dl>
193
194
  * <p>The following operations are related to <code>GetObject</code>:</p>