s3manager

package

v0.0.0-...-fee140a Latest Latest Go to latest Published: Mar 5, 2023 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

package s3manager provides methods and functions for downloading and uploading objects in AWS S3.

This section is empty.

This section is empty.

func NewS3() *s3.S3

NewS3 returns a configured S3 client.

func NewS3Downloader() *s3manager.Downloader

NewS3Downloader returns a configured Downloader client.

func NewS3Uploader() *s3manager.Uploader

NewS3Uploader returns a configured Uploader client.

type DownloaderAPI struct {
	Client s3manageriface.DownloaderAPI
}

DownloaderAPI wraps the Downloader API interface.

func (a *DownloaderAPI) Download(ctx aws.Context, bucket, key string, dst io.WriterAt) (int64, error)

Download is a convenience wrapper for downloading an object from S3.

func (a *DownloaderAPI) IsEnabled() bool

IsEnabled returns true if the client is enabled and ready for use.

func (a *DownloaderAPI) Setup()

Setup creates a new Downloader client.

type UploaderAPI struct {
	Client s3manageriface.UploaderAPI
}

UploaderAPI wraps the Uploader API interface.

func (a *UploaderAPI) IsEnabled() bool

IsEnabled returns true if the client is enabled and ready for use.

func (a *UploaderAPI) Setup()

Setup creates a new Uploader client.

func (a *UploaderAPI) Upload(ctx aws.Context, bucket, key string, src io.Reader) (*s3manager.UploadOutput, error)

Upload is a convenience wrapper for uploading an object to S3.