@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
52 lines (51 loc) • 2.85 kB
TypeScript
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
import { PutBucketPolicyRequest } from "../models/models_0";
import { Command as $Command } from "@aws-sdk/smithy-client";
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@aws-sdk/types";
export declare type PutBucketPolicyCommandInput = PutBucketPolicyRequest;
export declare type PutBucketPolicyCommandOutput = __MetadataBearer;
/**
* <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 AWS 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> As a security precaution, the root user of the AWS account that owns a bucket can
* always use this operation, even if the policy explicitly denies the root user the
* ability to perform this action. </p>
* </important>
*
*
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
* Policies</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>
*/
export declare class PutBucketPolicyCommand extends $Command<PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput, S3ClientResolvedConfig> {
readonly input: PutBucketPolicyCommandInput;
constructor(input: PutBucketPolicyCommandInput);
/**
* @internal
*/
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketPolicyCommandInput, PutBucketPolicyCommandOutput>;
private serialize;
private deserialize;
}