s3

Documentation

Index

• type Client
  • func NewSession(key, secret, region, bucket string) Client
  • func (s Client) GetObject(key string) ([]byte, error)
  • func (s Client) GetVersions(prefix string) ([]string, error)
  • func (s Client) ListObjects(prefix, delimiter string) (*s3.ListObjectsOutput, error)
  • func (s Client) Load(i interface{}, path string) error
  • func (s Client) PutObject(key, contentType string, object []byte) error
  • func (s Client) Save(i interface{}, path string) error

Types

type Client

type Client struct {
	Service s3iface.S3API
	Bucket  string
}

Client struct contains the initialized S3 service and other S3-related parameters

func NewSession

func NewSession(key, secret, region, bucket string) Client

NewSession creates an AWS session for S3 and returns an S3Client

func (Client) GetObject

func (s Client) GetObject(key string) ([]byte, error)

GetObject returns an object from S3

func (Client) GetVersions

func (s Client) GetVersions(prefix string) ([]string, error)

GetVersions returns a list of all versions under a given prefix in S3 This assumes a specific format when organizing the objects in the S3 bucket, e.g.

s3://bucket/prefix/1.0/file.json

func (Client) ListObjects

func (s Client) ListObjects(prefix, delimiter string) (*s3.ListObjectsOutput, error)

ListObjects returns a list of objects from S3

func (Client) Load

func (s Client) Load(i interface{}, path string) error

Load loads the json object from S3 (path) into the given interface

func (Client) PutObject

func (s Client) PutObject(key, contentType string, object []byte) error

PutObject takes a byte array and saves it in S3 with the given key name

func (Client) Save

func (s Client) Save(i interface{}, path string) error

Save saves an object to S3 (path) as JSON