@tachybase/module-file 0.23.8

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

@@ -0,0 +1,116 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetBucketLocationOutput, GetBucketLocationRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetBucketLocationCommand}.
+ */
+export interface GetBucketLocationCommandInput extends GetBucketLocationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetBucketLocationCommand}.
+ */
+export interface GetBucketLocationCommandOutput extends GetBucketLocationOutput, __MetadataBearer {
+}
+declare const GetBucketLocationCommand_base: {
+    new (input: GetBucketLocationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketLocationCommandInput, GetBucketLocationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetBucketLocationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketLocationCommandInput, GetBucketLocationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note>
+ *             <p>This operation is not supported for directory buckets.</p>
+ *          </note>
+ *          <p>Returns the Region the bucket resides in. You set the bucket's Region using the
+ *             <code>LocationConstraint</code> request parameter in a <code>CreateBucket</code>
+ *          request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>.</p>
+ *          <p>When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.</p>
+ *          <p>When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
+ * If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
+ * For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
+ *             Error Codes</a>.</p>
+ *          <note>
+ *             <p>We recommend that you use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a> to return the Region
+ *             that a bucket resides in. For backward compatibility, Amazon S3 continues to support
+ *             GetBucketLocation.</p>
+ *          </note>
+ *          <p>The following operations are related to <code>GetBucketLocation</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_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, GetBucketLocationCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, GetBucketLocationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // GetBucketLocationRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ * };
+ * const command = new GetBucketLocationCommand(input);
+ * const response = await client.send(command);
+ * // { // GetBucketLocationOutput
+ * //   LocationConstraint: "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ap-south-1" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ca-central-1" || "cn-north-1" || "cn-northwest-1" || "EU" || "eu-central-1" || "eu-north-1" || "eu-south-1" || "eu-south-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "me-south-1" || "sa-east-1" || "us-east-2" || "us-gov-east-1" || "us-gov-west-1" || "us-west-1" || "us-west-2",
+ * // };
+ *
+ * ```
+ *
+ * @param GetBucketLocationCommandInput - {@link GetBucketLocationCommandInput}
+ * @returns {@link GetBucketLocationCommandOutput}
+ * @see {@link GetBucketLocationCommandInput} for command's `input` shape.
+ * @see {@link GetBucketLocationCommandOutput} for command's `response` shape.
+ * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
+ *
+ * @throws {@link S3ServiceException}
+ * <p>Base exception class for all service exceptions from S3 service.</p>
+ *
+ * @public
+ * @example To get bucket location
+ * ```javascript
+ * // The following example returns bucket location.
+ * const input = {
+ *   "Bucket": "examplebucket"
+ * };
+ * const command = new GetBucketLocationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LocationConstraint": "us-west-2"
+ * }
+ * *\/
+ * // example id: to-get-bucket-location-1481594573609
+ * ```
+ *
+ */
+export declare class GetBucketLocationCommand extends GetBucketLocationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetBucketLocationRequest;
+            output: GetBucketLocationOutput;
+        };
+        sdk: {
+            input: GetBucketLocationCommandInput;
+            output: GetBucketLocationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,110 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetBucketLoggingOutput, GetBucketLoggingRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetBucketLoggingCommand}.
+ */
+export interface GetBucketLoggingCommandInput extends GetBucketLoggingRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetBucketLoggingCommand}.
+ */
+export interface GetBucketLoggingCommandOutput extends GetBucketLoggingOutput, __MetadataBearer {
+}
+declare const GetBucketLoggingCommand_base: {
+    new (input: GetBucketLoggingCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketLoggingCommandInput, GetBucketLoggingCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetBucketLoggingCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketLoggingCommandInput, GetBucketLoggingCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note>
+ *             <p>This operation is not supported for directory buckets.</p>
+ *          </note>
+ *          <p>Returns the logging status of a bucket and the permissions users have to view and modify
+ *          that status.</p>
+ *          <p>The following operations are related to <code>GetBucketLogging</code>:</p>
+ *          <ul>
+ *             <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_PutBucketLogging.html">PutBucketLogging</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, GetBucketLoggingCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, GetBucketLoggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // GetBucketLoggingRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ * };
+ * const command = new GetBucketLoggingCommand(input);
+ * const response = await client.send(command);
+ * // { // GetBucketLoggingOutput
+ * //   LoggingEnabled: { // LoggingEnabled
+ * //     TargetBucket: "STRING_VALUE", // required
+ * //     TargetGrants: [ // TargetGrants
+ * //       { // TargetGrant
+ * //         Grantee: { // Grantee
+ * //           DisplayName: "STRING_VALUE",
+ * //           EmailAddress: "STRING_VALUE",
+ * //           ID: "STRING_VALUE",
+ * //           URI: "STRING_VALUE",
+ * //           Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
+ * //         },
+ * //         Permission: "FULL_CONTROL" || "READ" || "WRITE",
+ * //       },
+ * //     ],
+ * //     TargetPrefix: "STRING_VALUE", // required
+ * //     TargetObjectKeyFormat: { // TargetObjectKeyFormat
+ * //       SimplePrefix: {},
+ * //       PartitionedPrefix: { // PartitionedPrefix
+ * //         PartitionDateSource: "EventTime" || "DeliveryTime",
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetBucketLoggingCommandInput - {@link GetBucketLoggingCommandInput}
+ * @returns {@link GetBucketLoggingCommandOutput}
+ * @see {@link GetBucketLoggingCommandInput} for command's `input` shape.
+ * @see {@link GetBucketLoggingCommandOutput} for command's `response` shape.
+ * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
+ *
+ * @throws {@link S3ServiceException}
+ * <p>Base exception class for all service exceptions from S3 service.</p>
+ *
+ * @public
+ */
+export declare class GetBucketLoggingCommand extends GetBucketLoggingCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetBucketLoggingRequest;
+            output: GetBucketLoggingOutput;
+        };
+        sdk: {
+            input: GetBucketLoggingCommandInput;
+            output: GetBucketLoggingCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,111 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetBucketMetadataTableConfigurationOutput, GetBucketMetadataTableConfigurationRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetBucketMetadataTableConfigurationCommand}.
+ */
+export interface GetBucketMetadataTableConfigurationCommandInput extends GetBucketMetadataTableConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetBucketMetadataTableConfigurationCommand}.
+ */
+export interface GetBucketMetadataTableConfigurationCommandOutput extends GetBucketMetadataTableConfigurationOutput, __MetadataBearer {
+}
+declare const GetBucketMetadataTableConfigurationCommand_base: {
+    new (input: GetBucketMetadataTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketMetadataTableConfigurationCommandInput, GetBucketMetadataTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetBucketMetadataTableConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketMetadataTableConfigurationCommandInput, GetBucketMetadataTableConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>
+ *          Retrieves the metadata table configuration for a general purpose bucket. For more
+ *          information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-overview.html">Accelerating data
+ *             discovery with S3 Metadata</a> in the <i>Amazon S3 User Guide</i>. </p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>To use this operation, you must have the <code>s3:GetBucketMetadataTableConfiguration</code> permission. For more
+ *                   information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/metadata-tables-permissions.html">Setting up
+ *                      permissions for configuring metadata tables</a> in the
+ *                   <i>Amazon S3 User Guide</i>. </p>
+ *             </dd>
+ *          </dl>
+ *          <p>The following operations are related to <code>GetBucketMetadataTableConfiguration</code>:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketMetadataTableConfiguration.html">CreateBucketMetadataTableConfiguration</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetadataTableConfiguration.html">DeleteBucketMetadataTableConfiguration</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, GetBucketMetadataTableConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, GetBucketMetadataTableConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // GetBucketMetadataTableConfigurationRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ * };
+ * const command = new GetBucketMetadataTableConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // GetBucketMetadataTableConfigurationOutput
+ * //   GetBucketMetadataTableConfigurationResult: { // GetBucketMetadataTableConfigurationResult
+ * //     MetadataTableConfigurationResult: { // MetadataTableConfigurationResult
+ * //       S3TablesDestinationResult: { // S3TablesDestinationResult
+ * //         TableBucketArn: "STRING_VALUE", // required
+ * //         TableName: "STRING_VALUE", // required
+ * //         TableArn: "STRING_VALUE", // required
+ * //         TableNamespace: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     Status: "STRING_VALUE", // required
+ * //     Error: { // ErrorDetails
+ * //       ErrorCode: "STRING_VALUE",
+ * //       ErrorMessage: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetBucketMetadataTableConfigurationCommandInput - {@link GetBucketMetadataTableConfigurationCommandInput}
+ * @returns {@link GetBucketMetadataTableConfigurationCommandOutput}
+ * @see {@link GetBucketMetadataTableConfigurationCommandInput} for command's `input` shape.
+ * @see {@link GetBucketMetadataTableConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
+ *
+ * @throws {@link S3ServiceException}
+ * <p>Base exception class for all service exceptions from S3 service.</p>
+ *
+ * @public
+ */
+export declare class GetBucketMetadataTableConfigurationCommand extends GetBucketMetadataTableConfigurationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetBucketMetadataTableConfigurationRequest;
+            output: GetBucketMetadataTableConfigurationOutput;
+        };
+        sdk: {
+            input: GetBucketMetadataTableConfigurationCommandInput;
+            output: GetBucketMetadataTableConfigurationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,128 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetBucketMetricsConfigurationOutput, GetBucketMetricsConfigurationRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetBucketMetricsConfigurationCommand}.
+ */
+export interface GetBucketMetricsConfigurationCommandInput extends GetBucketMetricsConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetBucketMetricsConfigurationCommand}.
+ */
+export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMetricsConfigurationOutput, __MetadataBearer {
+}
+declare const GetBucketMetricsConfigurationCommand_base: {
+    new (input: GetBucketMetricsConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketMetricsConfigurationCommandInput, GetBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetBucketMetricsConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketMetricsConfigurationCommandInput, GetBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note>
+ *             <p>This operation is not supported for directory buckets.</p>
+ *          </note>
+ *          <p>Gets a metrics configuration (specified by the metrics configuration ID) from the
+ *          bucket. Note that this doesn't include the daily storage metrics.</p>
+ *          <p> To use this operation, you must have permissions to perform the
+ *             <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
+ *          default. The bucket owner 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>.</p>
+ *          <p> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring
+ *             Metrics with Amazon CloudWatch</a>.</p>
+ *          <p>The following operations are related to
+ *          <code>GetBucketMetricsConfiguration</code>:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, GetBucketMetricsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, GetBucketMetricsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // GetBucketMetricsConfigurationRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   Id: "STRING_VALUE", // required
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ * };
+ * const command = new GetBucketMetricsConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // GetBucketMetricsConfigurationOutput
+ * //   MetricsConfiguration: { // MetricsConfiguration
+ * //     Id: "STRING_VALUE", // required
+ * //     Filter: { // MetricsFilter Union: only one key present
+ * //       Prefix: "STRING_VALUE",
+ * //       Tag: { // Tag
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //       AccessPointArn: "STRING_VALUE",
+ * //       And: { // MetricsAndOperator
+ * //         Prefix: "STRING_VALUE",
+ * //         Tags: [ // TagSet
+ * //           {
+ * //             Key: "STRING_VALUE", // required
+ * //             Value: "STRING_VALUE", // required
+ * //           },
+ * //         ],
+ * //         AccessPointArn: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetBucketMetricsConfigurationCommandInput - {@link GetBucketMetricsConfigurationCommandInput}
+ * @returns {@link GetBucketMetricsConfigurationCommandOutput}
+ * @see {@link GetBucketMetricsConfigurationCommandInput} for command's `input` shape.
+ * @see {@link GetBucketMetricsConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
+ *
+ * @throws {@link S3ServiceException}
+ * <p>Base exception class for all service exceptions from S3 service.</p>
+ *
+ * @public
+ */
+export declare class GetBucketMetricsConfigurationCommand extends GetBucketMetricsConfigurationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetBucketMetricsConfigurationRequest;
+            output: GetBucketMetricsConfigurationOutput;
+        };
+        sdk: {
+            input: GetBucketMetricsConfigurationCommandInput;
+            output: GetBucketMetricsConfigurationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,154 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetBucketNotificationConfigurationRequest, NotificationConfiguration } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetBucketNotificationConfigurationCommand}.
+ */
+export interface GetBucketNotificationConfigurationCommandInput extends GetBucketNotificationConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetBucketNotificationConfigurationCommand}.
+ */
+export interface GetBucketNotificationConfigurationCommandOutput extends NotificationConfiguration, __MetadataBearer {
+}
+declare const GetBucketNotificationConfigurationCommand_base: {
+    new (input: GetBucketNotificationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketNotificationConfigurationCommandInput, GetBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetBucketNotificationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<GetBucketNotificationConfigurationCommandInput, GetBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note>
+ *             <p>This operation is not supported for directory buckets.</p>
+ *          </note>
+ *          <p>Returns the notification configuration of a bucket.</p>
+ *          <p>If notifications are not enabled on the bucket, the action returns an empty
+ *             <code>NotificationConfiguration</code> element.</p>
+ *          <p>By default, you must be the bucket owner to read the notification configuration of a
+ *          bucket. However, the bucket owner can use a bucket policy to grant permission to other
+ *          users to read this configuration with the <code>s3:GetBucketNotification</code>
+ *          permission.</p>
+ *          <p>When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.</p>
+ *          <p>When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
+ * If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
+ * For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
+ *             Error Codes</a>.</p>
+ *          <p>For more information about setting and reading the notification configuration on a
+ *          bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of Bucket Events</a>. For more information about bucket
+ *          policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>.</p>
+ *          <p>The following action is related to <code>GetBucketNotification</code>:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html">PutBucketNotification</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, GetBucketNotificationConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, GetBucketNotificationConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // GetBucketNotificationConfigurationRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ * };
+ * const command = new GetBucketNotificationConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // NotificationConfiguration
+ * //   TopicConfigurations: [ // TopicConfigurationList
+ * //     { // TopicConfiguration
+ * //       Id: "STRING_VALUE",
+ * //       TopicArn: "STRING_VALUE", // required
+ * //       Events: [ // EventList // required
+ * //         "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
+ * //       ],
+ * //       Filter: { // NotificationConfigurationFilter
+ * //         Key: { // S3KeyFilter
+ * //           FilterRules: [ // FilterRuleList
+ * //             { // FilterRule
+ * //               Name: "prefix" || "suffix",
+ * //               Value: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   QueueConfigurations: [ // QueueConfigurationList
+ * //     { // QueueConfiguration
+ * //       Id: "STRING_VALUE",
+ * //       QueueArn: "STRING_VALUE", // required
+ * //       Events: [ // required
+ * //         "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
+ * //       ],
+ * //       Filter: {
+ * //         Key: {
+ * //           FilterRules: [
+ * //             {
+ * //               Name: "prefix" || "suffix",
+ * //               Value: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   LambdaFunctionConfigurations: [ // LambdaFunctionConfigurationList
+ * //     { // LambdaFunctionConfiguration
+ * //       Id: "STRING_VALUE",
+ * //       LambdaFunctionArn: "STRING_VALUE", // required
+ * //       Events: [ // required
+ * //         "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
+ * //       ],
+ * //       Filter: {
+ * //         Key: {
+ * //           FilterRules: [
+ * //             {
+ * //               Name: "prefix" || "suffix",
+ * //               Value: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   EventBridgeConfiguration: {},
+ * // };
+ *
+ * ```
+ *
+ * @param GetBucketNotificationConfigurationCommandInput - {@link GetBucketNotificationConfigurationCommandInput}
+ * @returns {@link GetBucketNotificationConfigurationCommandOutput}
+ * @see {@link GetBucketNotificationConfigurationCommandInput} for command's `input` shape.
+ * @see {@link GetBucketNotificationConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
+ *
+ * @throws {@link S3ServiceException}
+ * <p>Base exception class for all service exceptions from S3 service.</p>
+ *
+ * @public
+ */
+export declare class GetBucketNotificationConfigurationCommand extends GetBucketNotificationConfigurationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetBucketNotificationConfigurationRequest;
+            output: NotificationConfiguration;
+        };
+        sdk: {
+            input: GetBucketNotificationConfigurationCommandInput;
+            output: GetBucketNotificationConfigurationCommandOutput;
+        };
+    };
+}