UNPKG

@aws-sdk/client-s3

Version:

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

50 lines (49 loc) 3 kB
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { GetBucketPolicyStatusOutput, GetBucketPolicyStatusRequest } 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 GetBucketPolicyStatusCommandInput = GetBucketPolicyStatusRequest; export declare type GetBucketPolicyStatusCommandOutput = GetBucketPolicyStatusOutput & __MetadataBearer; /** * <p>Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. * In order to use this operation, you must have the <code>s3:GetBucketPolicyStatus</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> * * <p> For more information about when Amazon S3 considers a bucket 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>The following operations are related to <code>GetBucketPolicyStatus</code>:</p> * <ul> * <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> * <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_PutPublicAccessBlock.html">PutPublicAccessBlock</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">DeletePublicAccessBlock</a> * </p> * </li> * </ul> */ export declare class GetBucketPolicyStatusCommand extends $Command<GetBucketPolicyStatusCommandInput, GetBucketPolicyStatusCommandOutput, S3ClientResolvedConfig> { readonly input: GetBucketPolicyStatusCommandInput; constructor(input: GetBucketPolicyStatusCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketPolicyStatusCommandInput, GetBucketPolicyStatusCommandOutput>; private serialize; private deserialize; }