get-bucket-website

Returns the website configuration for a bucket.

See also: GET Bucket Website.

Synopsis

get-bucket-website
  --bucket <value>
  [--cli-input-json <value>]

Options

--bucket (string)

--cli-input-json (string)

Operates a service or services based on the provided JSON string. If other arguments are provided on the command line, the CLI values override the JSON-provided values. You cannot pass arbitrary binary values using a JSON-provided value, because the string is taken literally.

Examples

The following command retrieves the static website configuration for a bucket named “my-bucket”:

$ aws s3api get-bucket-website --bucket my-bucket

Output:

{
    "IndexDocument": {
        "Suffix": "index.html"
    },
    "ErrorDocument": {
        "Key": "error.html"
    }
}

Output

RedirectAllRequestsTo -> (structure)

HostName -> (string)

Name of the host where requests are redirected.

Protocol -> (string)

Protocol to use when redirecting requests. The default is the protocol used in the original request.

IndexDocument -> (structure)

Suffix -> (string)

A suffix appended to a request for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/, the data returned is for the object with the key name “images/index.html”). The suffix must not be empty and must not include a slash character.

ErrorDocument -> (structure)

Key -> (string)

The object key name to use when a 4XX class error occurs.

RoutingRules -> (list)

(structure)

Specifies the redirect behavior and when a redirect is applied.

Condition -> (structure)

A container for describing a condition that must be met for the specified redirect to apply. For example:

1. If the request is for pages in the /docs directory, redirect it to the /documents directory.
2. If the request results in an HTTP 4xx error, redirect the request to another host to process the error.

HttpErrorCodeReturnedEquals -> (string)

The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

KeyPrefixEquals -> (string)

The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix is ExamplePage.html. To redirect requests for all pages with the prefix docs/, the key prefix is /docs, which identifies all objects in the docs/ folder. This is required when the parent element, Condition, is specified, and the sibling element, HttpErrorCodeReturnedEquals is not. If both conditions are specified, both must be true for the redirect to be applied.

Redirect -> (structure)

Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. You can also specify a different error code to return.

HostName -> (string)

The host name to use in the redirect request.

HttpRedirectCode -> (string)

The HTTP redirect code to use on the response. Not required if one of the siblings is present.

Protocol -> (string)

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

ReplaceKeyPrefixWith -> (string)

The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ directory) to the documents/ directory, you can set a condition block with KeyPrefixEquals set to docs/ and in Redirect, set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

ReplaceKeyWith -> (string)

The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.