Class GetBucketWebsiteCommand

This operation is not supported for directory buckets.

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 Hosting Websites on Amazon S3.

This GET action requires the S3:GetBucketWebsite 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 S3:GetBucketWebsite permission.

The following operations are related to GetBucketWebsite:

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, GetBucketWebsiteCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketWebsiteCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // GetBucketWebsiteRequest
  Bucket: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketWebsiteCommand(input);
const response = await client.send(command);
// { // GetBucketWebsiteOutput
//   RedirectAllRequestsTo: { // RedirectAllRequestsTo
//     HostName: "STRING_VALUE", // required
//     Protocol: "http" || "https",
//   },
//   IndexDocument: { // IndexDocument
//     Suffix: "STRING_VALUE", // required
//   },
//   ErrorDocument: { // ErrorDocument
//     Key: "STRING_VALUE", // required
//   },
//   RoutingRules: [ // RoutingRules
//     { // RoutingRule
//       Condition: { // Condition
//         HttpErrorCodeReturnedEquals: "STRING_VALUE",
//         KeyPrefixEquals: "STRING_VALUE",
//       },
//       Redirect: { // Redirect
//         HostName: "STRING_VALUE",
//         HttpRedirectCode: "STRING_VALUE",
//         Protocol: "http" || "https",
//         ReplaceKeyPrefixWith: "STRING_VALUE",
//         ReplaceKeyWith: "STRING_VALUE",
//       },
//     },
//   ],
// };

Param: GetBucketWebsiteCommandInput

GetBucketWebsiteCommandInput

Returns

GetBucketWebsiteCommandOutput

See

GetBucketWebsiteCommandInput for command's input shape.
GetBucketWebsiteCommandOutput for command's response shape.
config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Example: To get bucket website configuration

// The following example retrieves website configuration of a bucket.
const input = {
  Bucket: "examplebucket"
};
const command = new GetBucketWebsiteCommand(input);
const response = await client.send(command);
/* response is
{
  ErrorDocument: {
    Key: "error.html"
  },
  IndexDocument: {
    Suffix: "index.html"
  }
}
*/

Hierarchy

CommandImpl<
    GetBucketWebsiteCommandInput,
    GetBucketWebsiteCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketWebsiteCommand

Index

Constructors

constructor

Constructors

constructor

new GetBucketWebsiteCommand(
input: GetBucketWebsiteCommandInput,
): GetBucketWebsiteCommand
Parameters
- input: GetBucketWebsiteCommandInput
Returns GetBucketWebsiteCommand
Inherited from $Command .classBuilder< GetBucketWebsiteCommandInput, GetBucketWebsiteCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketWebsite", {}) .n("S3Client", "GetBucketWebsiteCommand") .sc(GetBucketWebsite$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new GetBucketWebsiteCommand(
...__namedParameters: [GetBucketWebsiteCommandInput],
): GetBucketWebsiteCommand
Parameters
- ...__namedParameters: [GetBucketWebsiteCommandInput]
Returns GetBucketWebsiteCommand
Inherited from $Command .classBuilder< GetBucketWebsiteCommandInput, GetBucketWebsiteCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketWebsite", {}) .n("S3Client", "GetBucketWebsiteCommand") .sc(GetBucketWebsite$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class GetBucketWebsiteCommand

Example

Param: GetBucketWebsiteCommandInput

Returns

See

Throws

Example: To get bucket website configuration

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketWebsiteCommand

Parameters

Returns GetBucketWebsiteCommand

Settings

On This Page