@tachybase/module-file 1.3.17 → 1.3.18

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectAclCommand.d.ts

@@ -23,7 +23,7 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
 }
 declare const GetObjectAclCommand_base: {
     new (input: GetObjectAclCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectAclCommandInput, GetObjectAclCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetObjectAclCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectAclCommandInput, GetObjectAclCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetObjectAclCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectAclCommandInput, GetObjectAclCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -118,61 +118,61 @@ declare const GetObjectAclCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To retrieve object ACL
  * ```javascript
  * // The following example retrieves access control list (ACL) of an object.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectAclCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Grants": [
+ *   Grants: [
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "WRITE"
+ *       Permission: "WRITE"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "WRITE_ACP"
+ *       Permission: "WRITE_ACP"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "READ"
+ *       Permission: "READ"
  *     },
  *     {
- *       "Grantee": {
- *         "DisplayName": "owner-display-name",
- *         "ID": "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
- *         "Type": "CanonicalUser"
+ *       Grantee: {
+ *         DisplayName: "owner-display-name",
+ *         ID: "852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
+ *         Type: "CanonicalUser"
  *       },
- *       "Permission": "READ_ACP"
+ *       Permission: "READ_ACP"
  *     }
  *   ],
- *   "Owner": {
- *     "DisplayName": "owner-display-name",
- *     "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
+ *   Owner: {
+ *     DisplayName: "owner-display-name",
+ *     ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
  *   }
  * }
  * *\/
- * // example id: to-retrieve-object-acl-1481833557740
  * ```
  *
+ * @public
  */
 export declare class GetObjectAclCommand extends GetObjectAclCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectAttributesCommand.d.ts

@@ -23,22 +23,22 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
 }
 declare const GetObjectAttributesCommand_base: {
     new (input: GetObjectAttributesCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetObjectAttributesCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetObjectAttributesCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectAttributesCommandInput, GetObjectAttributesCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Retrieves all the metadata from an object without returning the object itself. This
+ * <p>Retrieves all of the metadata from an object without returning the object itself. This
  *          operation is useful if you're interested only in an object's metadata. </p>
  *          <p>
  *             <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code>
- *          and <code>ListParts</code>. All of the data returned with each of those individual calls
+ *          and <code>ListParts</code>. All of the data returned with both of those individual calls
  *          can be returned with a single call to <code>GetObjectAttributes</code>.</p>
  *          <note>
  *             <p>
  *                <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>
- *                </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
- *     <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
+ *             For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
+ *                </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
+ *     <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
  *     <i>Amazon S3 User Guide</i>.</p>
  *          </note>
  *          <dl>
@@ -48,16 +48,24 @@ declare const GetObjectAttributesCommand_base: {
  *                   <li>
  *                      <p>
  *                         <b>General purpose bucket permissions</b> - To
- *                         use <code>GetObjectAttributes</code>, you must have READ access to the
- *                         object. The permissions that you need to use this operation depend on
- *                         whether the bucket is versioned. If the bucket is versioned, you need both
- *                         the <code>s3:GetObjectVersion</code> and
- *                            <code>s3:GetObjectVersionAttributes</code> permissions for this
- *                         operation. If the bucket is not versioned, you need the
+ *                         use <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
+ *                      <p>The other permissions that you need to use this operation depend on
+ *                         whether the bucket is versioned and if a version ID is passed in the <code>GetObjectAttributes</code> request. </p>
+ *                      <ul>
+ *                         <li>
+ *                            <p>If you pass a version ID in your request, you need both the <code>s3:GetObjectVersion</code> and
+ *                            <code>s3:GetObjectVersionAttributes</code> permissions.</p>
+ *                         </li>
+ *                         <li>
+ *                            <p>If you do not pass a version ID in your request, you need the
  *                            <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code>
- *                         permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
+ *                         permissions. </p>
+ *                         </li>
+ *                      </ul>
+ *                      <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
  *                            Permissions in a Policy</a> in the
- *                            <i>Amazon S3 User Guide</i>. If the object that you request does
+ *                            <i>Amazon S3 User Guide</i>.</p>
+ *                      <p>If the object that you request does
  *                         not exist, the error Amazon S3 returns depends on whether you also have the
  *                            <code>s3:ListBucket</code> permission.</p>
  *                      <ul>
@@ -105,10 +113,10 @@ declare const GetObjectAttributesCommand_base: {
  *                      error. It's because the encryption method can't be changed when you retrieve
  *                      the object.</p>
  *                </note>
- *                <p>If you encrypt an object by using server-side encryption with customer-provided
- *                   encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve
- *                   the metadata from the object, you must use the following headers to provide the
- *                   encryption key for the server to be able to retrieve the object's metadata. The
+ *                <p>If you encrypted an object when you stored the object in Amazon S3 by using server-side encryption with customer-provided
+ *                   encryption keys (SSE-C), then when you retrieve
+ *                   the metadata from the object, you must use the following headers. These headers provide the
+ *                   server with the encryption key required to retrieve the object's metadata. The
  *                   headers are: </p>
  *                <ul>
  *                   <li>
@@ -271,8 +279,10 @@ declare const GetObjectAttributesCommand_base: {
  * //   Checksum: { // Checksum
  * //     ChecksumCRC32: "STRING_VALUE",
  * //     ChecksumCRC32C: "STRING_VALUE",
+ * //     ChecksumCRC64NVME: "STRING_VALUE",
  * //     ChecksumSHA1: "STRING_VALUE",
  * //     ChecksumSHA256: "STRING_VALUE",
+ * //     ChecksumType: "COMPOSITE" || "FULL_OBJECT",
  * //   },
  * //   ObjectParts: { // GetObjectAttributesParts
  * //     TotalPartsCount: Number("int"),
@@ -286,12 +296,13 @@ declare const GetObjectAttributesCommand_base: {
  * //         Size: Number("long"),
  * //         ChecksumCRC32: "STRING_VALUE",
  * //         ChecksumCRC32C: "STRING_VALUE",
+ * //         ChecksumCRC64NVME: "STRING_VALUE",
  * //         ChecksumSHA1: "STRING_VALUE",
  * //         ChecksumSHA256: "STRING_VALUE",
  * //       },
  * //     ],
  * //   },
- * //   StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE",
+ * //   StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE" || "FSX_OPENZFS",
  * //   ObjectSize: Number("long"),
  * // };
  *
@@ -309,6 +320,7 @@ declare const GetObjectAttributesCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectAttributesCommand extends GetObjectAttributesCommand_base {

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectCommand.d.ts

@@ -24,7 +24,7 @@ export interface GetObjectCommandOutput extends Omit<GetObjectOutput, "Body">, _
 }
 declare const GetObjectCommand_base: {
     new (input: GetObjectCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectCommandInput, GetObjectCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetObjectCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectCommandInput, GetObjectCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetObjectCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectCommandInput, GetObjectCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -42,9 +42,9 @@ declare const GetObjectCommand_base: {
  *             Header Bucket Specification</a> in the <i>Amazon S3 User Guide</i>.</p>
  *          <p>
  *             <b>Directory buckets</b> -
- *          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>
- *             </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
- *     <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
+ *          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>amzn-s3-demo-bucket--usw2-az1--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>
+ *             </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
+ *     <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
  *     <i>Amazon S3 User Guide</i>.</p>
  *          <dl>
  *             <dt>Permissions</dt>
@@ -112,7 +112,7 @@ declare const GetObjectCommand_base: {
  *                      Objects</a> in the <i>Amazon S3 User Guide</i>.</p>
  *                <p>
  *                   <b>Directory buckets </b> -
- *                   For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
+ *                   Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
  * Unsupported storage class values won't write a destination object and will respond with the HTTP status code <code>400 Bad Request</code>.</p>
  *             </dd>
  *             <dt>Encryption</dt>
@@ -235,6 +235,11 @@ declare const GetObjectCommand_base: {
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
  * // { // GetObjectOutput
  * //   Body: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
  * //   DeleteMarker: true || false,
@@ -246,8 +251,10 @@ declare const GetObjectCommand_base: {
  * //   ETag: "STRING_VALUE",
  * //   ChecksumCRC32: "STRING_VALUE",
  * //   ChecksumCRC32C: "STRING_VALUE",
+ * //   ChecksumCRC64NVME: "STRING_VALUE",
  * //   ChecksumSHA1: "STRING_VALUE",
  * //   ChecksumSHA256: "STRING_VALUE",
+ * //   ChecksumType: "COMPOSITE" || "FULL_OBJECT",
  * //   MissingMeta: Number("int"),
  * //   VersionId: "STRING_VALUE",
  * //   CacheControl: "STRING_VALUE",
@@ -259,7 +266,7 @@ declare const GetObjectCommand_base: {
  * //   Expires: new Date("TIMESTAMP"),
  * //   ExpiresString: "STRING_VALUE",
  * //   WebsiteRedirectLocation: "STRING_VALUE",
- * //   ServerSideEncryption: "AES256" || "aws:kms" || "aws:kms:dsse",
+ * //   ServerSideEncryption: "AES256" || "aws:fsx" || "aws:kms" || "aws:kms:dsse",
  * //   Metadata: { // Metadata
  * //     "<keys>": "STRING_VALUE",
  * //   },
@@ -267,7 +274,7 @@ declare const GetObjectCommand_base: {
  * //   SSECustomerKeyMD5: "STRING_VALUE",
  * //   SSEKMSKeyId: "STRING_VALUE",
  * //   BucketKeyEnabled: true || false,
- * //   StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE",
+ * //   StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE" || "FSX_OPENZFS",
  * //   RequestCharged: "requester",
  * //   ReplicationStatus: "COMPLETE" || "PENDING" || "FAILED" || "REPLICA" || "COMPLETED",
  * //   PartsCount: Number("int"),
@@ -301,56 +308,65 @@ declare const GetObjectCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To retrieve a byte range of an object
  * ```javascript
  * // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "SampleFile.txt",
- *   "Range": "bytes=0-9"
+ *   Bucket: "examplebucket",
+ *   Key: "SampleFile.txt",
+ *   Range: "bytes=0-9"
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
  * {
- *   "AcceptRanges": "bytes",
- *   "ContentLength": "10",
- *   "ContentRange": "bytes 0-9/43",
- *   "ContentType": "text/plain",
- *   "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
- *   "LastModified": "2014-10-09T22:57:28.000Z",
- *   "Metadata": {},
- *   "VersionId": "null"
+ *   AcceptRanges: "bytes",
+ *   ContentLength: 10,
+ *   ContentRange: "bytes 0-9/43",
+ *   ContentType: "text/plain",
+ *   ETag: `"0d94420ffd0bc68cd3d152506b97a9cc"`,
+ *   LastModified: "2014-10-09T22:57:28.000Z",
+ *   Metadata:   { /* empty *\/ },
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
  * ```
  *
  * @example To retrieve an object
  * ```javascript
  * // The following example retrieves an object for an S3 bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
  * {
- *   "AcceptRanges": "bytes",
- *   "ContentLength": "3191",
- *   "ContentType": "image/jpeg",
- *   "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *   "LastModified": "2016-12-15T01:19:41.000Z",
- *   "Metadata": {},
- *   "TagCount": 2,
- *   "VersionId": "null"
+ *   AcceptRanges: "bytes",
+ *   ContentLength: 3191,
+ *   ContentType: "image/jpeg",
+ *   ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *   LastModified: "2016-12-15T01:19:41.000Z",
+ *   Metadata:   { /* empty *\/ },
+ *   TagCount: 2,
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-an-object-1481827837012
  * ```
  *
+ * @public
  */
 export declare class GetObjectCommand extends GetObjectCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectLegalHoldCommand.d.ts

@@ -23,7 +23,7 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu
 }
 declare const GetObjectLegalHoldCommand_base: {
     new (input: GetObjectLegalHoldCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectLegalHoldCommandInput, GetObjectLegalHoldCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetObjectLegalHoldCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectLegalHoldCommandInput, GetObjectLegalHoldCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetObjectLegalHoldCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectLegalHoldCommandInput, GetObjectLegalHoldCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -73,6 +73,7 @@ declare const GetObjectLegalHoldCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectLegalHoldCommand extends GetObjectLegalHoldCommand_base {

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectLockConfigurationCommand.d.ts

@@ -23,7 +23,7 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo
 }
 declare const GetObjectLockConfigurationCommand_base: {
     new (input: GetObjectLockConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectLockConfigurationCommandInput, GetObjectLockConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetObjectLockConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectLockConfigurationCommandInput, GetObjectLockConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetObjectLockConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectLockConfigurationCommandInput, GetObjectLockConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -77,6 +77,7 @@ declare const GetObjectLockConfigurationCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectLockConfigurationCommand extends GetObjectLockConfigurationCommand_base {

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectRetentionCommand.d.ts

@@ -23,7 +23,7 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
 }
 declare const GetObjectRetentionCommand_base: {
     new (input: GetObjectRetentionCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectRetentionCommandInput, GetObjectRetentionCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetObjectRetentionCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectRetentionCommandInput, GetObjectRetentionCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetObjectRetentionCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectRetentionCommandInput, GetObjectRetentionCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -74,6 +74,7 @@ declare const GetObjectRetentionCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetObjectRetentionCommand extends GetObjectRetentionCommand_base {

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectTaggingCommand.d.ts

@@ -23,7 +23,7 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _
 }
 declare const GetObjectTaggingCommand_base: {
     new (input: GetObjectTaggingCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectTaggingCommandInput, GetObjectTaggingCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetObjectTaggingCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectTaggingCommandInput, GetObjectTaggingCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetObjectTaggingCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectTaggingCommandInput, GetObjectTaggingCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -95,58 +95,57 @@ declare const GetObjectTaggingCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
- * @example To retrieve tag set of an object
+ *
+ * @example To retrieve tag set of a specific object version
  * ```javascript
- * // The following example retrieves tag set of an object.
+ * // The following example retrieves tag set of an object. The request specifies object version.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "exampleobject",
+ *   VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * };
  * const command = new GetObjectTaggingCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "TagSet": [
- *     {
- *       "Key": "Key4",
- *       "Value": "Value4"
- *     },
+ *   TagSet: [
  *     {
- *       "Key": "Key3",
- *       "Value": "Value3"
+ *       Key: "Key1",
+ *       Value: "Value1"
  *     }
  *   ],
- *   "VersionId": "null"
+ *   VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
  * }
  * *\/
- * // example id: to-retrieve-tag-set-of-an-object-1481833847896
  * ```
  *
- * @example To retrieve tag set of a specific object version
+ * @example To retrieve tag set of an object
  * ```javascript
- * // The following example retrieves tag set of an object. The request specifies object version.
+ * // The following example retrieves tag set of an object.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "exampleobject",
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectTaggingCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "TagSet": [
+ *   TagSet: [
+ *     {
+ *       Key: "Key4",
+ *       Value: "Value4"
+ *     },
  *     {
- *       "Key": "Key1",
- *       "Value": "Value1"
+ *       Key: "Key3",
+ *       Value: "Value3"
  *     }
  *   ],
- *   "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
+ *   VersionId: "null"
  * }
  * *\/
- * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
  * ```
  *
+ * @public
  */
 export declare class GetObjectTaggingCommand extends GetObjectTaggingCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetObjectTorrentCommand.d.ts

@@ -24,7 +24,7 @@ export interface GetObjectTorrentCommandOutput extends Omit<GetObjectTorrentOutp
 }
 declare const GetObjectTorrentCommand_base: {
     new (input: GetObjectTorrentCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectTorrentCommandInput, GetObjectTorrentCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetObjectTorrentCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectTorrentCommandInput, GetObjectTorrentCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetObjectTorrentCommandInput): import("@smithy/smithy-client").CommandImpl<GetObjectTorrentCommandInput, GetObjectTorrentCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -62,6 +62,11 @@ declare const GetObjectTorrentCommand_base: {
  * };
  * const command = new GetObjectTorrentCommand(input);
  * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
  * // { // GetObjectTorrentOutput
  * //   Body: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
  * //   RequestCharged: "requester",
@@ -78,19 +83,27 @@ declare const GetObjectTorrentCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To retrieve torrent files for an object
  * ```javascript
  * // The following example retrieves torrent files of an object.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "HappyFace.jpg"
+ *   Bucket: "examplebucket",
+ *   Key: "HappyFace.jpg"
  * };
  * const command = new GetObjectTorrentCommand(input);
- * await client.send(command);
- * // example id: to-retrieve-torrent-files-for-an-object-1481834115959
+ * const response = await client.send(command);
+ * // consume or destroy the stream to free the socket.
+ * const bytes = await response.Body.transformToByteArray();
+ * // const str = await response.Body.transformToString();
+ * // response.Body.destroy(); // only applicable to Node.js Readable streams.
+ *
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class GetObjectTorrentCommand extends GetObjectTorrentCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist/node_modules/@aws-sdk/client-s3/dist-types/commands/GetPublicAccessBlockCommand.d.ts

@@ -23,7 +23,7 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO
 }
 declare const GetPublicAccessBlockCommand_base: {
     new (input: GetPublicAccessBlockCommandInput): import("@smithy/smithy-client").CommandImpl<GetPublicAccessBlockCommandInput, GetPublicAccessBlockCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: GetPublicAccessBlockCommandInput): import("@smithy/smithy-client").CommandImpl<GetPublicAccessBlockCommandInput, GetPublicAccessBlockCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetPublicAccessBlockCommandInput): import("@smithy/smithy-client").CommandImpl<GetPublicAccessBlockCommandInput, GetPublicAccessBlockCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -99,6 +99,7 @@ declare const GetPublicAccessBlockCommand_base: {
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export declare class GetPublicAccessBlockCommand extends GetPublicAccessBlockCommand_base {