Get Bucket Website

s3_get_bucket_website

R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by 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 get_bucket_website:

• delete_bucket_website

• put_bucket_website

Usage

s3_get_bucket_website(Bucket, ExpectedBucketOwner)

Arguments

Bucket

[required] The bucket name for which to get the website configuration.

ExpectedBucketOwner

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ⁠403 Forbidden⁠ (access denied).

Value

A list with the following syntax:

list(
  RedirectAllRequestsTo = list(
    HostName = "string",
    Protocol = "http"|"https"
  ),
  IndexDocument = list(
    Suffix = "string"
  ),
  ErrorDocument = list(
    Key = "string"
  ),
  RoutingRules = list(
    list(
      Condition = list(
        HttpErrorCodeReturnedEquals = "string",
        KeyPrefixEquals = "string"
      ),
      Redirect = list(
        HostName = "string",
        HttpRedirectCode = "string",
        Protocol = "http"|"https",
        ReplaceKeyPrefixWith = "string",
        ReplaceKeyWith = "string"
      )
    )
  )
)

Request syntax

svc$get_bucket_website(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)

Examples

## Not run: 
# The following example retrieves website configuration of a bucket.
svc$get_bucket_website(
  Bucket = "examplebucket"
)

## End(Not run)