Skip to content

delete_bucket_website

Operation

delete_bucket_website

delete_bucket_website(request: DeleteBucketWebsiteInput | DeleteBucketWebsiteInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteBucketWebsiteInputDict]) -> DeleteBucketWebsiteOutput
Note

This operation is not supported for directory buckets.

This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3.

The following operations are related to DeleteBucketWebsite:

Warning

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.

Parameters:

Name Type Description Default
request DeleteBucketWebsiteInput | DeleteBucketWebsiteInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DeleteBucketWebsiteInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteBucketWebsiteOutput

An instance of DeleteBucketWebsiteOutput.

delete_bucket_website async

delete_bucket_website(request: DeleteBucketWebsiteInput | DeleteBucketWebsiteInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteBucketWebsiteInputDict]) -> DeleteBucketWebsiteOutput
Note

This operation is not supported for directory buckets.

This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3.

The following operations are related to DeleteBucketWebsite:

Warning

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.

Parameters:

Name Type Description Default
request DeleteBucketWebsiteInput | DeleteBucketWebsiteInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DeleteBucketWebsiteInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteBucketWebsiteOutput

An instance of DeleteBucketWebsiteOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteBucketWebsiteInputDict

Bases: TypedDict

Dictionary form of DeleteBucketWebsiteInput.

Attributes

bucket instance-attribute
bucket: Required[str]

The bucket name for which you want to remove the website configuration.

expected_bucket_owner instance-attribute
expected_bucket_owner: str | None

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).

DeleteBucketWebsiteInput dataclass

Bases: _SerdeShape

Dataclass for DeleteBucketWebsiteInput structure.

Attributes

bucket class-attribute instance-attribute
bucket: str | None = ...

The bucket name for which you want to remove the website configuration.

expected_bucket_owner class-attribute instance-attribute
expected_bucket_owner: str | None = ...

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).

Output

DeleteBucketWebsiteOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteBucketWebsiteOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.