Skip to content

Rename S3 to AWS_S3 #38904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
---
title: S3
description: Instructions on how to setup S3 bucket to be used as a backup location.
title: AWS S3
description: Instructions on how to setup AWS S3 bucket to be used as a backup location.
ha_release: 2025.4
ha_category:
- Backup
ha_iot_class: Cloud Push
ha_config_flow: true
ha_domain: s3
ha_domain: aws_s3
ha_codeowners:
- '@tomasbedrich'
ha_integration_type: service
---

The **S3** {% term integrations %} allows you to use S3 bucket with Home Assistant Backups.

[AWS S3](https://aws.amazon.com/s3/) is the most widely known service with S3 API.
Any S3-compatible service (for example, [Minio](https://github.com/minio/minio)) should work with this integration as well.
The **AWS S3** {% term integrations %} allows you to use [AWS S3](https://aws.amazon.com/s3/) bucket with Home Assistant Backups.

{% include integrations/config_flow.md %}

{% configuration_basic %}
Access Key ID:
description: "The access key ID for your S3 account."
description: "The access key ID for your AWS S3 account."
Secret Access Key:
description: "The secret access key for your S3 account."
description: "The secret access key for your AWS S3 account."
Bucket Name:
description: "S3 bucket name to store the backups. Bucket must already exist and be writable by the provided credentials."
Endpoint URL:
Comment on lines 24 to 26
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Align Bucket Name Description with AWS S3
The “Bucket Name” description still reads “S3 bucket name”. For consistency, please update it to “AWS S3 bucket name”, e.g.:

- description: "S3 bucket name to store the backups. Bucket must already exist and be writable by the provided credentials."
+ description: "AWS S3 bucket name to store the backups. Bucket must already exist and be writable by the provided credentials."
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Bucket Name:
description: "S3 bucket name to store the backups. Bucket must already exist and be writable by the provided credentials."
Endpoint URL:
Bucket Name:
description: "AWS S3 bucket name to store the backups. Bucket must already exist and be writable by the provided credentials."
Endpoint URL:

Expand Down