---
date_last_completed: 2026-05-18
---
The `aws_s3` package provides functions to assist in handling large volumes of files through AWS S3 (Simple Storage Service).
## `configure`: Configure the AWS S3 settings.
Configure the settings for use with AWS S3.
Parameters:
- `region_endpoint` (string, optional): Region endpoint.
- `service_url` (string, optional): Service URL
- `access_key_id` (string, required): Access key ID.
- `secret_access_key` (string, required): Secret access key.
## `copy_object`: Copy an object.
Copy an object within AWS S3.
Parameters:
- `client` (object, required): The AWS S3 client object.
- `source_bucket` (string, required): Source bucket.
- `source_key` (string, required): Source key.
- `destination_bucket` (string, required): Destination bucket.
- `destination_key` (string, required): Destination key.
- `storage_class` (string, optional): Storage class.
- `content_type` (string, optional): Content type.
## `download_object`: Download an object.
Download an object from AWS S3.
Parameters:
- `client` (object, required): The AWS S3 client object.
- `bucket` (string, required): The name of the bucket that contains the object.
- `key` (string, required): Key.
## `get_object_metadata`: Get object metadata.
Get AWS S3 object metadata.
Parameters:
- `client` (object, required): The AWS S3 client object.
- `bucket` (string, required): The name of the bucket that contains the object.
- `key` (string, required): The object key.
## `list_buckets`: List all buckets.
List all AWS S3 buckets.
Parameters:
- `client` (object, required): The AWS S3 client object.
## `list_directory_buckets`: List all directory buckets.
List all AWS S3 directory buckets.
Parameters:
- `client` (object, required): The AWS S3 client object.
## `list_objects`: List objects.
List objects buckets.
Parameters:
- `client` (object, required): The AWS S3 client object.
- `bucket` (string, required): The name of the bucket that contains the object.
## `upload_object`: Upload an object.
Upload an object within AWS S3.
Parameters:
- `client` (object, required): The AWS S3 client object.
- `bucket` (string, required): The name of the bucket that contains the object.
- `key` (string, required): Key.
- `payload` (byte[], required): Binary payload.
- `storage_class` (string, optional): Storage class.
- `content_type` (string, optional): Content type.