Skip to content

hokiebrian/s3_size

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

S3 Bucket Info for Home Assistant

release_badge release_date License hacs_badge

Installation

This provides a sensor that shows details of a AWS S3 Bucket - size (in GB) and number of objects. You will need an Access Key and Secret from AWS that has ListAllMyBuckets and ListBucket permissions for the S3 service.

Install Custom Components

  1. Make sure that Home Assistant Community Store (HACS) is setup.
  2. Go to integrations in HACS
  3. Click the 3 dots in the top right corner and choose Custom repositories
  4. Paste the following into the repository input field https://github.com/hokiebrian/s3_size and choose category of Integration
  5. Click add and restart HA to let the integration load
  6. Go to settings and choose Devices & Services
  7. Click Add Integration and search for S3 Bucket Info
  8. Configure the integration by copying your Bucket Name and AWS Credentials when prompted

Usage

This sensor does not update automatically due to the overhead associated with large buckets. AWS allows only 1000 objects to be fetched at a time. A Service S3 Size Update is provided to be used in automations, scripts, or Tap Actions. The size returned is in GB, not GiB. AWS bills using GB and the S3 console displays in GiB.