Class GetBucketWebsiteCommandProtected

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:

• DeleteBucketWebsite

• PutBucketWebsite

Example

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

import { S3Client, GetBucketWebsiteCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketWebsiteCommand } = require("@aws-sdk/client-s3"); // CommonJS import
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

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 ==
{
  "ErrorDocument": {
    "Key": "error.html"
  },
  "IndexDocument": {
    "Suffix": "index.html"
  }
}
*/
// example id: to-get-bucket-website-configuration-1483037016926