Overview

This document provides an overview of APIs and SDK code samples related to static website.

Setting Static Website

Feature description

This API (PUT Bucket website) is used to configure a static website for a bucket.

Method prototype

put_bucket_website(Bucket, WebsiteConfiguration={}, **kwargs)

Sample request

response = client.put_bucket_website(
    Bucket='bucket',
    WebsiteConfiguration={
        'IndexDocument': {
            'Suffix': 'string'
        },
        'ErrorDocument': {
            'Key': 'string'
        },
        'RedirectAllRequestsTo': {
            'Protocol': 'http'|'https'
        },
        'RoutingRules': [
            {
                'Condition': {
                    'HttpErrorCodeReturnedEquals': 'string',
                    'KeyPrefixEquals': 'string'
                },
                'Redirect': {
                    'HttpRedirectCode': 'string',
                    'Protocol': 'http'|'https',
                    'ReplaceKeyPrefixWith': 'string',
                    'ReplaceKeyWith': 'string'
                }
            }
        ]
    }
)

Parameter description

Returned result description

The returned value of this method is None.

Querying Static Website Configuration

Feature description

This API (GET Bucket website) is used to query the configuration information of a static website associated with a bucket.

Method prototype

get_bucket_website(Bucket, **kwargs)

Sample request

response = client.get_bucket_website(
    Bucket='examplebucket-1250000000'
)

Parameter description

Returned result description

Static website configuration of the bucket in dict type.

{
    'IndexDocument': {
        'Suffix': 'string'
    },
    'ErrorDocument': {
        'Key': 'string'
    },
    'RedirectAllRequestsTo': {
        'Protocol': 'http'|'https'
    },
    'RoutingRules': [
        {
            'Condition': {
                'HttpErrorCodeReturnedEquals': 'string',
                'KeyPrefixEquals': 'string'
            },
            'Redirect': {
                'HttpRedirectCode': 'string',
                'Protocol': 'http'|'https',
                'ReplaceKeyPrefixWith': 'string',
                'ReplaceKeyWith': 'string'
            }
        }
    ]
}

Deleting Static Website Configuration

Feature description

This API (DELETE Bucket website) is used to delete the static website configuration of a bucket.

Method prototype

delete_bucket_website(Bucket, **kwargs)

Sample request

response = client.delete_bucket_website(
    Bucket='examplebucket-1250000000'
)

Parameter description

Returned result description

The returned value of this method is None.