@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
40 lines (39 loc) • 2.43 kB
TypeScript
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
import { GetBucketWebsiteOutput, GetBucketWebsiteRequest } 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 GetBucketWebsiteCommandInput = GetBucketWebsiteRequest;
export declare type GetBucketWebsiteCommandOutput = GetBucketWebsiteOutput & __MetadataBearer;
/**
* <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can
* configure a bucket as website by adding a website configuration. For more information about
* hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on
* Amazon S3</a>. </p>
* <p>This GET operation requires the <code>S3:GetBucketWebsite</code> permission. By default,
* only the bucket owner can read the bucket website configuration. However, bucket owners can
* allow other users to read the website configuration by writing a bucket policy granting
* them the <code>S3:GetBucketWebsite</code> permission.</p>
* <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html">DeleteBucketWebsite</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html">PutBucketWebsite</a>
* </p>
* </li>
* </ul>
*/
export declare class GetBucketWebsiteCommand extends $Command<GetBucketWebsiteCommandInput, GetBucketWebsiteCommandOutput, S3ClientResolvedConfig> {
readonly input: GetBucketWebsiteCommandInput;
constructor(input: GetBucketWebsiteCommandInput);
/**
* @internal
*/
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBucketWebsiteCommandInput, GetBucketWebsiteCommandOutput>;
private serialize;
private deserialize;
}