@tachybase/module-file 0.23.8

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

@@ -0,0 +1,196 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListObjectsOutput, ListObjectsRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListObjectsCommand}.
+ */
+export interface ListObjectsCommandInput extends ListObjectsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListObjectsCommand}.
+ */
+export interface ListObjectsCommandOutput extends ListObjectsOutput, __MetadataBearer {
+}
+declare const ListObjectsCommand_base: {
+    new (input: ListObjectsCommandInput): import("@smithy/smithy-client").CommandImpl<ListObjectsCommandInput, ListObjectsCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListObjectsCommandInput): import("@smithy/smithy-client").CommandImpl<ListObjectsCommandInput, ListObjectsCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note>
+ *             <p>This operation is not supported for directory buckets.</p>
+ *          </note>
+ *          <p>Returns some or all (up to 1,000) of the objects in a bucket. You can use the request
+ *          parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK
+ *          response can contain valid or invalid XML. Be sure to design your application to parse the
+ *          contents of the response and handle it appropriately.</p>
+ *          <important>
+ *             <p>This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, when developing applications. For backward compatibility,
+ *             Amazon S3 continues to support <code>ListObjects</code>.</p>
+ *          </important>
+ *          <p>The following operations are related to <code>ListObjects</code>:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, ListObjectsCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, ListObjectsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // ListObjectsRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   Delimiter: "STRING_VALUE",
+ *   EncodingType: "url",
+ *   Marker: "STRING_VALUE",
+ *   MaxKeys: Number("int"),
+ *   Prefix: "STRING_VALUE",
+ *   RequestPayer: "requester",
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ *   OptionalObjectAttributes: [ // OptionalObjectAttributesList
+ *     "RestoreStatus",
+ *   ],
+ * };
+ * const command = new ListObjectsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListObjectsOutput
+ * //   IsTruncated: true || false,
+ * //   Marker: "STRING_VALUE",
+ * //   NextMarker: "STRING_VALUE",
+ * //   Contents: [ // ObjectList
+ * //     { // Object
+ * //       Key: "STRING_VALUE",
+ * //       LastModified: new Date("TIMESTAMP"),
+ * //       ETag: "STRING_VALUE",
+ * //       ChecksumAlgorithm: [ // ChecksumAlgorithmList
+ * //         "CRC32" || "CRC32C" || "SHA1" || "SHA256",
+ * //       ],
+ * //       Size: Number("long"),
+ * //       StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "GLACIER" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE",
+ * //       Owner: { // Owner
+ * //         DisplayName: "STRING_VALUE",
+ * //         ID: "STRING_VALUE",
+ * //       },
+ * //       RestoreStatus: { // RestoreStatus
+ * //         IsRestoreInProgress: true || false,
+ * //         RestoreExpiryDate: new Date("TIMESTAMP"),
+ * //       },
+ * //     },
+ * //   ],
+ * //   Name: "STRING_VALUE",
+ * //   Prefix: "STRING_VALUE",
+ * //   Delimiter: "STRING_VALUE",
+ * //   MaxKeys: Number("int"),
+ * //   CommonPrefixes: [ // CommonPrefixList
+ * //     { // CommonPrefix
+ * //       Prefix: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   EncodingType: "url",
+ * //   RequestCharged: "requester",
+ * // };
+ *
+ * ```
+ *
+ * @param ListObjectsCommandInput - {@link ListObjectsCommandInput}
+ * @returns {@link ListObjectsCommandOutput}
+ * @see {@link ListObjectsCommandInput} for command's `input` shape.
+ * @see {@link ListObjectsCommandOutput} for command's `response` shape.
+ * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
+ *
+ * @throws {@link NoSuchBucket} (client fault)
+ *  <p>The specified bucket does not exist.</p>
+ *
+ * @throws {@link S3ServiceException}
+ * <p>Base exception class for all service exceptions from S3 service.</p>
+ *
+ * @public
+ * @example To list objects in a bucket
+ * ```javascript
+ * // The following example list two objects in a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "MaxKeys": "2"
+ * };
+ * const command = new ListObjectsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Contents": [
+ *     {
+ *       "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
+ *       "Key": "example1.jpg",
+ *       "LastModified": "2014-11-21T19:40:05.000Z",
+ *       "Owner": {
+ *         "DisplayName": "myname",
+ *         "ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
+ *       },
+ *       "Size": 11,
+ *       "StorageClass": "STANDARD"
+ *     },
+ *     {
+ *       "ETag": "\"9c8af9a76df052144598c115ef33e511\"",
+ *       "Key": "example2.jpg",
+ *       "LastModified": "2013-11-15T01:10:49.000Z",
+ *       "Owner": {
+ *         "DisplayName": "myname",
+ *         "ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
+ *       },
+ *       "Size": 713193,
+ *       "StorageClass": "STANDARD"
+ *     }
+ *   ],
+ *   "NextMarker": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
+ * }
+ * *\/
+ * // example id: to-list-objects-in-a-bucket-1473447646507
+ * ```
+ *
+ */
+export declare class ListObjectsCommand extends ListObjectsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListObjectsRequest;
+            output: ListObjectsOutput;
+        };
+        sdk: {
+            input: ListObjectsCommandInput;
+            output: ListObjectsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,261 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListObjectsV2Output, ListObjectsV2Request } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListObjectsV2Command}.
+ */
+export interface ListObjectsV2CommandInput extends ListObjectsV2Request {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListObjectsV2Command}.
+ */
+export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __MetadataBearer {
+}
+declare const ListObjectsV2Command_base: {
+    new (input: ListObjectsV2CommandInput): import("@smithy/smithy-client").CommandImpl<ListObjectsV2CommandInput, ListObjectsV2CommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListObjectsV2CommandInput): import("@smithy/smithy-client").CommandImpl<ListObjectsV2CommandInput, ListObjectsV2CommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can
+ *          use the request parameters as selection criteria to return a subset of the objects in a
+ *          bucket. A <code>200 OK</code> response can contain valid or invalid XML. Make sure to
+ *          design your application to parse the contents of the response and handle it appropriately.
+ *          For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys
+ *             programmatically</a> in the <i>Amazon S3 User Guide</i>. To get a list of
+ *          your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>.</p>
+ *          <note>
+ *             <ul>
+ *                <li>
+ *                   <p>
+ *                      <b>General purpose bucket</b> - For general purpose buckets,
+ *                      <code>ListObjectsV2</code> doesn't return prefixes that are related only to
+ *                   in-progress multipart uploads.</p>
+ *                </li>
+ *                <li>
+ *                   <p>
+ *                      <b>Directory buckets</b> - For
+ *                   directory buckets, <code>ListObjectsV2</code> response includes the prefixes that
+ *                   are related only to in-progress multipart uploads. </p>
+ *                </li>
+ *                <li>
+ *                   <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
+ *     <i>Amazon S3 User Guide</i>.</p>
+ *                </li>
+ *             </ul>
+ *          </note>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <b>General purpose bucket permissions</b> - To
+ *                         use this operation, you must have READ access to the bucket. You must have
+ *                         permission to perform the <code>s3:ListBucket</code> action. The bucket
+ *                         owner has this permission by default and can grant this permission to
+ *                         others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
+ *                            Permissions to Your Amazon S3 Resources</a> in the
+ *                            <i>Amazon S3 User Guide</i>.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <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">
+ *                            <code>CreateSession</code>
+ *                         </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.
+ * 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">
+ *                            <code>CreateSession</code>
+ *                         </a>.</p>
+ *                   </li>
+ *                </ul>
+ *             </dd>
+ *             <dt>Sorting order of returned objects</dt>
+ *             <dd>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <b>General purpose bucket</b> - For
+ *                         general purpose buckets, <code>ListObjectsV2</code> returns objects in
+ *                         lexicographical order based on their key names.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>
+ *                         <b>Directory bucket</b> - For
+ *                         directory buckets, <code>ListObjectsV2</code> does not return objects in
+ *                         lexicographical order.</p>
+ *                   </li>
+ *                </ul>
+ *             </dd>
+ *             <dt>HTTP Host header syntax</dt>
+ *             <dd>
+ *                <p>
+ *                   <b>Directory buckets </b> - The HTTP Host header syntax is <code>
+ *                      <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
+ *             </dd>
+ *          </dl>
+ *          <important>
+ *             <p>This section describes the latest revision of this action. We recommend that you use
+ *             this revised API operation for application development. For backward compatibility, Amazon S3
+ *             continues to support the prior version of this API operation, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
+ *          </important>
+ *          <p>The following operations are related to <code>ListObjectsV2</code>:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, ListObjectsV2Command } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, ListObjectsV2Command } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // ListObjectsV2Request
+ *   Bucket: "STRING_VALUE", // required
+ *   Delimiter: "STRING_VALUE",
+ *   EncodingType: "url",
+ *   MaxKeys: Number("int"),
+ *   Prefix: "STRING_VALUE",
+ *   ContinuationToken: "STRING_VALUE",
+ *   FetchOwner: true || false,
+ *   StartAfter: "STRING_VALUE",
+ *   RequestPayer: "requester",
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ *   OptionalObjectAttributes: [ // OptionalObjectAttributesList
+ *     "RestoreStatus",
+ *   ],
+ * };
+ * const command = new ListObjectsV2Command(input);
+ * const response = await client.send(command);
+ * // { // ListObjectsV2Output
+ * //   IsTruncated: true || false,
+ * //   Contents: [ // ObjectList
+ * //     { // Object
+ * //       Key: "STRING_VALUE",
+ * //       LastModified: new Date("TIMESTAMP"),
+ * //       ETag: "STRING_VALUE",
+ * //       ChecksumAlgorithm: [ // ChecksumAlgorithmList
+ * //         "CRC32" || "CRC32C" || "SHA1" || "SHA256",
+ * //       ],
+ * //       Size: Number("long"),
+ * //       StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "GLACIER" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE",
+ * //       Owner: { // Owner
+ * //         DisplayName: "STRING_VALUE",
+ * //         ID: "STRING_VALUE",
+ * //       },
+ * //       RestoreStatus: { // RestoreStatus
+ * //         IsRestoreInProgress: true || false,
+ * //         RestoreExpiryDate: new Date("TIMESTAMP"),
+ * //       },
+ * //     },
+ * //   ],
+ * //   Name: "STRING_VALUE",
+ * //   Prefix: "STRING_VALUE",
+ * //   Delimiter: "STRING_VALUE",
+ * //   MaxKeys: Number("int"),
+ * //   CommonPrefixes: [ // CommonPrefixList
+ * //     { // CommonPrefix
+ * //       Prefix: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   EncodingType: "url",
+ * //   KeyCount: Number("int"),
+ * //   ContinuationToken: "STRING_VALUE",
+ * //   NextContinuationToken: "STRING_VALUE",
+ * //   StartAfter: "STRING_VALUE",
+ * //   RequestCharged: "requester",
+ * // };
+ *
+ * ```
+ *
+ * @param ListObjectsV2CommandInput - {@link ListObjectsV2CommandInput}
+ * @returns {@link ListObjectsV2CommandOutput}
+ * @see {@link ListObjectsV2CommandInput} for command's `input` shape.
+ * @see {@link ListObjectsV2CommandOutput} for command's `response` shape.
+ * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
+ *
+ * @throws {@link NoSuchBucket} (client fault)
+ *  <p>The specified bucket does not exist.</p>
+ *
+ * @throws {@link S3ServiceException}
+ * <p>Base exception class for all service exceptions from S3 service.</p>
+ *
+ * @public
+ * @example To get object list
+ * ```javascript
+ * // The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.
+ * const input = {
+ *   "Bucket": "DOC-EXAMPLE-BUCKET",
+ *   "MaxKeys": "2"
+ * };
+ * const command = new ListObjectsV2Command(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Contents": [
+ *     {
+ *       "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
+ *       "Key": "happyface.jpg",
+ *       "LastModified": "2014-11-21T19:40:05.000Z",
+ *       "Size": 11,
+ *       "StorageClass": "STANDARD"
+ *     },
+ *     {
+ *       "ETag": "\"becf17f89c30367a9a44495d62ed521a-1\"",
+ *       "Key": "test.jpg",
+ *       "LastModified": "2014-05-02T04:51:50.000Z",
+ *       "Size": 4192256,
+ *       "StorageClass": "STANDARD"
+ *     }
+ *   ],
+ *   "IsTruncated": true,
+ *   "KeyCount": "2",
+ *   "MaxKeys": "2",
+ *   "Name": "DOC-EXAMPLE-BUCKET",
+ *   "NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==",
+ *   "Prefix": ""
+ * }
+ * *\/
+ * // example id: to-get-object-list
+ * ```
+ *
+ */
+export declare class ListObjectsV2Command extends ListObjectsV2Command_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListObjectsV2Request;
+            output: ListObjectsV2Output;
+        };
+        sdk: {
+            input: ListObjectsV2CommandInput;
+            output: ListObjectsV2CommandOutput;
+        };
+    };
+}