UNPKG

@aws-sdk/client-s3

Version:

AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native

82 lines (81 loc) 4.37 kB
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types"; import { PutPublicAccessBlockRequest } from "../models/models_1"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; export interface PutPublicAccessBlockCommandInput extends PutPublicAccessBlockRequest { } export interface PutPublicAccessBlockCommandOutput extends __MetadataBearer { } /** * <p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. * To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> * permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a * Policy</a>.</p> * * <important> * <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or * an object, it checks the <code>PublicAccessBlock</code> configuration for both the * bucket (or the bucket that contains the object) and the bucket owner's account. If the * <code>PublicAccessBlock</code> configurations are different between the bucket and * the account, Amazon S3 uses the most restrictive combination of the bucket-level and * account-level settings.</p> * </important> * * * <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>.</p> * * * * <p class="title"> * <b>Related Resources</b> * </p> * <ul> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html">GetPublicAccessBlock</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html">GetBucketPolicyStatus</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html">Using Amazon S3 Block * Public Access</a> * </p> * </li> * </ul> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, PutPublicAccessBlockCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, PutPublicAccessBlockCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const command = new PutPublicAccessBlockCommand(input); * const response = await client.send(command); * ``` * * @see {@link PutPublicAccessBlockCommandInput} for command's `input` shape. * @see {@link PutPublicAccessBlockCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * */ export declare class PutPublicAccessBlockCommand extends $Command<PutPublicAccessBlockCommandInput, PutPublicAccessBlockCommandOutput, S3ClientResolvedConfig> { readonly input: PutPublicAccessBlockCommandInput; static getEndpointParameterInstructions(): EndpointParameterInstructions; constructor(input: PutPublicAccessBlockCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutPublicAccessBlockCommandInput, PutPublicAccessBlockCommandOutput>; private serialize; private deserialize; }