@nocobase/plugin-file-manager 0.11.1-alpha.5 → 0.12.0-alpha.2

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

@@ -0,0 +1,140 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { PutBucketMetricsConfigurationRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutBucketMetricsConfigurationCommand}.
+ */
+export interface PutBucketMetricsConfigurationCommandInput extends PutBucketMetricsConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutBucketMetricsConfigurationCommand}.
+ */
+export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
+ *          You can have up to 1,000 metrics configurations per bucket. If you're updating an existing
+ *          metrics configuration, note that this is a full replacement of the existing metrics
+ *          configuration. If you don't include the elements you want to keep, they are erased.</p>
+ *          <p>To use this operation, you must have permissions to perform the
+ *             <code>s3:PutMetricsConfiguration</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>PutBucketMetricsConfiguration</code>:</p>
+ *          <ul>
+ *             <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_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <code>PutBucketMetricsConfiguration</code> has the following special error:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Error code: <code>TooManyConfigurations</code>
+ *                </p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Description: You are attempting to create a new configuration but have
+ *                      already reached the 1,000-configuration limit.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>HTTP Status Code: HTTP 400 Bad Request</p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, PutBucketMetricsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, PutBucketMetricsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // PutBucketMetricsConfigurationRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   Id: "STRING_VALUE", // required
+ *   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",
+ *       },
+ *     },
+ *   },
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ * };
+ * const command = new PutBucketMetricsConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PutBucketMetricsConfigurationCommandInput - {@link PutBucketMetricsConfigurationCommandInput}
+ * @returns {@link PutBucketMetricsConfigurationCommandOutput}
+ * @see {@link PutBucketMetricsConfigurationCommandInput} for command's `input` shape.
+ * @see {@link PutBucketMetricsConfigurationCommandOutput} 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>
+ *
+ */
+export declare class PutBucketMetricsConfigurationCommand extends $Command<PutBucketMetricsConfigurationCommandInput, PutBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig> {
+    readonly input: PutBucketMetricsConfigurationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutBucketMetricsConfigurationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketMetricsConfigurationCommandInput, PutBucketMetricsConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,205 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { PutBucketNotificationConfigurationRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutBucketNotificationConfigurationCommand}.
+ */
+export interface PutBucketNotificationConfigurationCommandInput extends PutBucketNotificationConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutBucketNotificationConfigurationCommand}.
+ */
+export interface PutBucketNotificationConfigurationCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Enables notifications of specified events for a bucket. For more information about event
+ *          notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event
+ *          Notifications</a>.</p>
+ *          <p>Using this API, you can replace an existing notification configuration. The
+ *          configuration is an XML file that defines the event types that you want Amazon S3 to publish and
+ *          the destination where you want Amazon S3 to publish an event notification when it detects an
+ *          event of the specified type.</p>
+ *          <p>By default, your bucket has no event notifications configured. That is, the notification
+ *          configuration will be an empty <code>NotificationConfiguration</code>.</p>
+ *          <p>
+ *             <code><NotificationConfiguration></code>
+ *          </p>
+ *          <p>
+ *             <code></NotificationConfiguration></code>
+ *          </p>
+ *          <p>This action replaces the existing notification configuration with the configuration you
+ *          include in the request body.</p>
+ *          <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification
+ *          Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and
+ *          that the bucket owner has permission to publish to it by sending a test notification. In
+ *          the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions
+ *          grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,
+ *          see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3 Events</a>.</p>
+ *          <p>You can disable notifications by adding the empty NotificationConfiguration
+ *          element.</p>
+ *          <p>For more information about the number of event notification configurations that you can
+ *          create per bucket, see <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service quotas</a> in <i>Amazon Web Services
+ *             General Reference</i>.</p>
+ *          <p>By default, only the bucket owner can configure notifications on a bucket. However,
+ *          bucket owners can use a bucket policy to grant permission to other users to set this
+ *          configuration with the required <code>s3:PutBucketNotification</code> permission.</p>
+ *          <note>
+ *             <p>The PUT notification is an atomic operation. For example, suppose your notification
+ *             configuration includes SNS topic, SQS queue, and Lambda function configurations. When
+ *             you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS
+ *             topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the
+ *             configuration to your bucket.</p>
+ *          </note>
+ *          <p>If the configuration in the request body includes only one
+ *             <code>TopicConfiguration</code> specifying only the
+ *             <code>s3:ReducedRedundancyLostObject</code> event type, the response will also include
+ *          the <code>x-amz-sns-test-message-id</code> header containing the message ID of the test
+ *          notification sent to the topic.</p>
+ *          <p>The following action is related to
+ *          <code>PutBucketNotificationConfiguration</code>:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, PutBucketNotificationConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, PutBucketNotificationConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // PutBucketNotificationConfigurationRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   NotificationConfiguration: { // 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: {},
+ *   },
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ *   SkipDestinationValidation: true || false,
+ * };
+ * const command = new PutBucketNotificationConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PutBucketNotificationConfigurationCommandInput - {@link PutBucketNotificationConfigurationCommandInput}
+ * @returns {@link PutBucketNotificationConfigurationCommandOutput}
+ * @see {@link PutBucketNotificationConfigurationCommandInput} for command's `input` shape.
+ * @see {@link PutBucketNotificationConfigurationCommandOutput} 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>
+ *
+ * @example Set notification configuration for a bucket
+ * ```javascript
+ * // The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "NotificationConfiguration": {
+ *     "TopicConfigurations": [
+ *       {
+ *         "Events": [
+ *           "s3:ObjectCreated:*"
+ *         ],
+ *         "TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic"
+ *       }
+ *     ]
+ *   }
+ * };
+ * const command = new PutBucketNotificationConfigurationCommand(input);
+ * await client.send(command);
+ * // example id: set-notification-configuration-for-a-bucket-1482270296426
+ * ```
+ *
+ */
+export declare class PutBucketNotificationConfigurationCommand extends $Command<PutBucketNotificationConfigurationCommandInput, PutBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig> {
+    readonly input: PutBucketNotificationConfigurationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutBucketNotificationConfigurationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketNotificationConfigurationCommandInput, PutBucketNotificationConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,98 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { PutBucketOwnershipControlsRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutBucketOwnershipControlsCommand}.
+ */
+export interface PutBucketOwnershipControlsCommandInput extends PutBucketOwnershipControlsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutBucketOwnershipControlsCommand}.
+ */
+export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this
+ *          operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For
+ *          more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a
+ *             policy</a>. </p>
+ *          <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html">Using object
+ *             ownership</a>. </p>
+ *          <p>The following operations are related to <code>PutBucketOwnershipControls</code>:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a>GetBucketOwnershipControls</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a>DeleteBucketOwnershipControls</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, PutBucketOwnershipControlsCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, PutBucketOwnershipControlsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // PutBucketOwnershipControlsRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   ContentMD5: "STRING_VALUE",
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ *   OwnershipControls: { // OwnershipControls
+ *     Rules: [ // OwnershipControlsRules // required
+ *       { // OwnershipControlsRule
+ *         ObjectOwnership: "BucketOwnerPreferred" || "ObjectWriter" || "BucketOwnerEnforced", // required
+ *       },
+ *     ],
+ *   },
+ * };
+ * const command = new PutBucketOwnershipControlsCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PutBucketOwnershipControlsCommandInput - {@link PutBucketOwnershipControlsCommandInput}
+ * @returns {@link PutBucketOwnershipControlsCommandOutput}
+ * @see {@link PutBucketOwnershipControlsCommandInput} for command's `input` shape.
+ * @see {@link PutBucketOwnershipControlsCommandOutput} 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>
+ *
+ */
+export declare class PutBucketOwnershipControlsCommand extends $Command<PutBucketOwnershipControlsCommandInput, PutBucketOwnershipControlsCommandOutput, S3ClientResolvedConfig> {
+    readonly input: PutBucketOwnershipControlsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutBucketOwnershipControlsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketOwnershipControlsCommandInput, PutBucketOwnershipControlsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,118 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { PutBucketPolicyRequest } from "../models/models_0";
+import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutBucketPolicyCommand}.
+ */
+export interface PutBucketPolicyCommandInput extends PutBucketPolicyRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutBucketPolicyCommand}.
+ */
+export interface PutBucketPolicyCommandOutput extends __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than
+ *          the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
+ *             <code>PutBucketPolicy</code> permissions on the specified bucket and belong to the
+ *          bucket owner's account in order to use this operation.</p>
+ *          <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403
+ *             Access Denied</code> error. If you have the correct permissions, but you're not using an
+ *          identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not
+ *             Allowed</code> error.</p>
+ *          <important>
+ *             <p>To ensure that bucket owners don't inadvertently lock themselves out of their own
+ *             buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
+ *             <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
+ *             <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
+ *             denies the root principal's access. Bucket owner root principals can only be blocked from performing
+ *             these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
+ *          </important>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
+ *             examples</a>.</p>
+ *          <p>The following operations are related to <code>PutBucketPolicy</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_DeleteBucket.html">DeleteBucket</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3Client, PutBucketPolicyCommand } from "@aws-sdk/client-s3"; // ES Modules import
+ * // const { S3Client, PutBucketPolicyCommand } = require("@aws-sdk/client-s3"); // CommonJS import
+ * const client = new S3Client(config);
+ * const input = { // PutBucketPolicyRequest
+ *   Bucket: "STRING_VALUE", // required
+ *   ContentMD5: "STRING_VALUE",
+ *   ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
+ *   ConfirmRemoveSelfBucketAccess: true || false,
+ *   Policy: "STRING_VALUE", // required
+ *   ExpectedBucketOwner: "STRING_VALUE",
+ * };
+ * const command = new PutBucketPolicyCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PutBucketPolicyCommandInput - {@link PutBucketPolicyCommandInput}
+ * @returns {@link PutBucketPolicyCommandOutput}
+ * @see {@link PutBucketPolicyCommandInput} for command's `input` shape.
+ * @see {@link PutBucketPolicyCommandOutput} 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>
+ *
+ * @example Set bucket policy
+ * ```javascript
+ * // The following example sets a permission policy on a bucket.
+ * const input = {
+ *   "Bucket": "examplebucket",
+ *   "Policy": "{\"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"id-1\",\"Effect\": \"Allow\",\"Principal\": {\"AWS\": \"arn:aws:iam::123456789012:root\"}, \"Action\": [ \"s3:PutObject\",\"s3:PutObjectAcl\"], \"Resource\": [\"arn:aws:s3:::acl3/*\" ] } ]}"
+ * };
+ * const command = new PutBucketPolicyCommand(input);
+ * await client.send(command);
+ * // example id: set-bucket-policy-1482448903302
+ * ```
+ *
+ */
+export declare class PutBucketPolicyCommand extends $Command<PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput, S3ClientResolvedConfig> {
+    readonly input: PutBucketPolicyCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: PutBucketPolicyCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}