hot.dev/aws-s3 / ::aws::s3::buckets

Functions

create-bucket

fn (bucket: Str, region: Str): CreateBucketResponse | AwsError
fn (bucket: Str): CreateBucketResponse | AwsError

Create a new S3 bucket.

Example

result ::aws::s3::buckets/create-bucket("my-new-bucket", "us-east-1")
result.location  // => "http://my-new-bucket.s3.amazonaws.com/"

// Use default region from context
result ::aws::s3::buckets/create-bucket("my-new-bucket")

delete-bucket

fn (bucket: Str): Bool | AwsError

Delete an S3 bucket. The bucket must be empty before it can be deleted.

Example

::aws::s3::buckets/delete-bucket("my-bucket")
// => true

head-bucket

fn (bucket: Str): HeadBucketResponse | AwsError

HEAD a bucket to check if it exists and get its region.

Example

result ::aws::s3::buckets/head-bucket("my-bucket")
result.exists  // => true

list-buckets

fn (): ListBucketsResponse | AwsError

List all S3 buckets in the account.

Example

result ::aws::s3::buckets/list-buckets()
result.buckets
// => [{name: "my-bucket", creation_date: "2024-01-01T00:00:00Z"}, ...]

Types

CreateBucketResponse

CreateBucketResponse type {
    location: Str?
}

HeadBucketResponse

HeadBucketResponse type {
    exists: Bool,
    region: Str?
}

ListBucketsResponse

ListBucketsResponse type {
    owner: Map?,
    buckets: Vec?
}

S3Bucket

S3Bucket type {
    name: Str,
    creation_date: Str?
}